net.sf.mmm.client.ui.api.widget.panel

Interface UiWidgetGridPanel

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAriaRole, AttributeReadColumnCount, AttributeReadDisposed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteColumnCount, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiWidget, UiWidgetAbstractComposite, UiWidgetComposite<UiWidgetGridRow>, UiWidgetDynamicComposite<UiWidgetGridRow>, UiWidgetDynamicPanel<UiWidgetGridRow>, UiWidgetMultiComposite<UiWidgetGridRow>, UiWidgetNative, UiWidgetPanel<UiWidgetGridRow>, UiWidgetRegular, UiWidgetRegularComposite<UiWidgetGridRow>

All Known Implementing Classes:

AbstractUiWidgetGridPanel, UiWidgetGridPanelGwt, UiWidgetGridPanelTestImpl

public interface UiWidgetGridPanel
extends UiWidgetDynamicPanel<UiWidgetGridRow>, AttributeWriteColumnCount, UiWidgetNative

This is the interface for a dynamic panel that represents a flexible grid. It consists of rows that themselves consists of cells. You can think of this widget as an HTML table used for layout (role=presentation).
ATTENTION:
Please initialize the grid using AttributeWriteColumnCount.setColumnCount(int) to get consistent results.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_GRID_PANEL The default primary style of this widget.

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Method Summary

Modifier and Type	Method and Description
UiWidgetGridRow	addChildren(UiWidgetRegular... children) This method creates a UiWidgetGridRow, adds the given children to it and then adds it to this UiWidgetGridPanel.
UiWidgetGridRow	addChildSpanned(UiWidgetRegular child) This method creates a UiWidgetGridRow, adds the given child with a full column span to it and then adds it to this UiWidgetGridPanel.
void	addSeparatorRow() Adds an empty row that acts as a spacer to group blocks of rows with widgets.
RolePresentation	getAriaRole() This method gets the Accessibility.WAI_ARIA role of this object.

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetDynamicComposite

addChild, addChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetMultiComposite

removeChild, removeChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetComposite

getChild, getChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetAbstractComposite

getChildCount, getChildIndex

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

getStyles

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadPrimaryStyle

getPrimaryStyle

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteColumnCount

setColumnCount

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadColumnCount

getColumnCount

Field Detail

STYLE_GRID_PANEL

static final String STYLE_GRID_PANEL

The default primary style of this widget.

See Also:

Constant Field Values

Method Detail

getAriaRole

RolePresentation getAriaRole()

This method gets the Accessibility.WAI_ARIA role of this object.
ATTENTION:
A reasonable UI framework (e.g. when using UiWidget) is supposed to provide high-level widgets and support setting the according Role and their attributes automatically. Therefore users should only use this for special situations e.g. for setting aria-hidden intentionally for a visible object. Here RolePresentation is used so the implementation can use a table as layout element.

Specified by:

getAriaRole in interface AttributeReadAriaRole

Returns:

the Role or null if NOT set.

See Also:

Accessibility

addChildSpanned

UiWidgetGridRow addChildSpanned(UiWidgetRegular child)

This method creates a UiWidgetGridRow, adds the given child with a full column span to it and then adds it to this UiWidgetGridPanel.
ATTENTION:
It is strongly recommended to call AttributeWriteColumnCount.setColumnCount(int) before using the method.

Parameters:

child - is the child widget to show in a row with the full width of this panel.

Returns:

the created UiWidgetGridRow.

addChildren

UiWidgetGridRow addChildren(UiWidgetRegular... children)

This method creates a UiWidgetGridRow, adds the given children to it and then adds it to this UiWidgetGridPanel.

Parameters:

children - are the child widgets to show in a row of this panel.

Returns:

the created UiWidgetGridRow.

addSeparatorRow

void addSeparatorRow()

Adds an empty row that acts as a spacer to group blocks of rows with widgets. This row will have the style CssStyles.GRID_ROW_SEPARATOR.