WComponent content models

• WComponents by content type
  • Any content
  • Components which require phrasing content
  • Components which must not include interactive controls
• WComponents by category
  • Phrasing content
  • Flow content which is not phrasing content
  • Sectioning content
    • Sectioning roots
  • form-bound controls
• Interactive components
• No output
• Further information

WComponents by content type

The following lists the allowed content types for container WComponents. For information about content types see the Content model specification and Content category specification.

Any content

These WComponents may contain any content including form-bound controls:

• WCollapsible;
• WContainer;
• WPanel;
• WFieldSet;
• WFigure;
• WSection;
• WDecoratedLabel if it is the title component of a WSection, the description of a WFigure or a column header in a WTable.

Components which require phrasing content

The WComponents below may have other WComponents added to them but may not contain any of the WComponents which output content which is not phrasing content (see below).

• WDecoratedLabel including:

  • the title component of a WCollapsible;
  • the title component of a WFieldSet;
  • the title component of a WHeading;
  • the title component of a WSection;
  • the title component of a WSubMenu;
  • the title component of a WMenuItem;
  • the title component of a WTab;

  unless the WDecoratedLabel is the title component of a WSection, the description of a WFigure or a column header in a WTable;

• WLabel.

Components which must not include interactive controls

The following WComponents are able to accept other components as content but which may not contain any of the form bound controls listed on this page.

• the title component of a WSubMenu;
• the title component of a WMenuItem;
• WLabel (with some exceptions which are harder to implement than not).

The title component of a WCollapsible and the title component of a WFieldSet may contain interactive controls but not complex form controls. It is recommended that these labeling elements should not contain any interactive control due to issues which may arise from ambiguity of interaction. It is strongly recommended that the title component of a WTab and the title component of a WCollapsible should not contain interactive components.

WComponents by category

The following lists WComponents by their category. You should also consult the list of WComponent form controls.

Phrasing content

These WComponents are stand-alone components which output only phrasing content and may, therefore be used anywhere where phrasing content is permitted.

• WAbbrText;
• WContentLink;
• WDecoratedLabel unless it is the titling element of a WSection, the title component of a WTab or a header in a WTableColumn;
• WImage;
• WInternaLink;
• WLabel;
• WLink;
• WProgressBar;
• WStyledText unless the white-space is PARAGRAPH or PRESERVE;
• WText (unless set to output unescaped text and the content contains mark-up which creates non-phrase content);
• WComponents which output labelable elements except WDateField, WPartialDateField and WTextArea in rich-text mode - note that these components may not be used where interactive components are forbidden;
• WComponents which output labelable elements if in a read-only state except WTextArea in rich-text mode which outputs non-phrasing content and may output form-bound controls.

Flow content which is not phrasing content

The following WComponents are those which are stand-alone components so can be placed anywhere in the Java tree but output HTML which contains one or more elements which are incompatible with a phrasing content content model. None of these elements may be used where phrasing content is required.

• WAjaxPollingRegion
• WAudio;
• WCollapsible;
• WCollapsibleToggle;
• WDateField unless in a read-only state;
• WDefinitionList;
• WDialog;
• WDropdown if in the COMBO mode;
• WFieldLayout;
• WFieldSet;
• WFieldWarningIndicator;
• WFigure;
• WHeading;
• WHorizontalRule;
• WMenu;
• WMessageBox;
• WPanel;
• WPartialDateField;
• WRow;
• WSection;
• WSelectToggle unless the render mode is CONTROL;
• WStyledText if the whiteSpace property is PARAGRAPH or PRESERVE;
• WTable;
• WTabSet;
• WTree;
• WValidationErrors;
• WVideo;
• All WComponents which output complex form controls.

Sectioning content

The following components will output sectioning content:

• WPanel with WPanel.Type.ACTION or WPanel.Type.CHROME;
• WSection.

Sectioning roots

The following WComponents will output a sectioning root.

• WCollapsible;
• WDialog;
• WFieldSet;
• WFigure.

form-bound controls

• See WComponent form controls.

Interactive components

• All WComponent form controls;
• WAudio
• WContentLink
• WDialog
• WInternaLink
• WLink
• WMenu
• WTable (if any of sort, row expansion, row seelction or pagination are enabled);
• WTabSet
• WTree
• WVideo

No output

WComponents without UI artefacts (except WComponents in a hidden state) do not output HTML at the point in the output tree equivalent to their point in the component tree. For most purposes they can be considered empty and any WComponent or (or sub-component which outputs a wrapper element) which contains only one or more of these components suffers from being empty. A WComponent which contains only WComponents without UI artefacts (including WComponents in a hidden state) does not have palpable content which may create an accessibility issue.

Further information

• Content model definition on WHATWG
• Content categories on WHATWG
• List of WComponents
• WComponent form controls
• WComponents without UI artefacts