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

Class AbstractUiWidgetGridPanel<ADAPTER extends UiWidgetAdapterGridPanel>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative<ADAPTER,Void>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetComposite<ADAPTER,CHILD>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetDynamicComposite<ADAPTER,CHILD>

net.sf.mmm.client.ui.base.widget.panel.AbstractUiWidgetDynamicPanel<ADAPTER,UiWidgetGridRow>

net.sf.mmm.client.ui.base.widget.panel.AbstractUiWidgetGridPanel<ADAPTER>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadColumnCount, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteColumnCount, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<Void>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<Void>, UiFeatureValue<Void>, UiFeatureValueAndValidation<Void>, UiWidgetDynamicPanel<UiWidgetGridRow>, UiWidgetGridPanel, UiWidgetPanel<UiWidgetGridRow>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<Void>, UiWidgetComposite<UiWidgetGridRow>, UiWidgetDynamicComposite<UiWidgetGridRow>, UiWidgetMultiComposite<UiWidgetGridRow>, UiWidgetNative, UiWidgetRegular, UiWidgetRegularComposite<UiWidgetGridRow>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

UiWidgetGridPanelGwt, UiWidgetGridPanelTestImpl

public abstract class AbstractUiWidgetGridPanel<ADAPTER extends UiWidgetAdapterGridPanel>
extends AbstractUiWidgetDynamicPanel<ADAPTER,UiWidgetGridRow>
implements UiWidgetGridPanel

This is the abstract base implementation of UiWidgetGridPanel.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

AbstractUiWidgetNative.SizeImpl

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private Integer	columnCount

Fields inherited from interface net.sf.mmm.client.ui.api.widget.panel.UiWidgetGridPanel

STYLE_GRID_PANEL

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

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetGridPanel(UiContext context, ADAPTER widgetAdapter) The constructor.

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.
protected Class<? extends Role>	getAriaRoleFixedType()
Integer	getColumnCount() This method gets the number of columns of this object (e.g.
void	setColumnCount(int columnCount) This method sets the columnCount attribute.

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetDynamicComposite

addChild, addChild, doAddChild, getChild, getChildCount, getChildIndex, initializeWidgetAdapter, removeChild, removeChild

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetComposite

getChild

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setFocused, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, visibilityChanged

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getSource, getValueClass, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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.AttributeWriteValueAdvanced

resetValue, setValue, setValueForUser

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

getValue

Field Detail

columnCount

private Integer columnCount

See Also:

getColumnCount()

Constructor Detail

AbstractUiWidgetGridPanel

public AbstractUiWidgetGridPanel(UiContext context,
                                 ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

getAriaRole

public 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.

Specified by:

getAriaRole in interface AttributeReadAriaRole

Specified by:

getAriaRole in interface UiWidgetGridPanel

Overrides:

getAriaRole in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterGridPanel,Void>

Returns:

the Role or null if NOT set.

See Also:

Accessibility

getColumnCount

public Integer getColumnCount()

This method gets the number of columns of this object (e.g. a table).

Specified by:

getColumnCount in interface AttributeReadColumnCount

Returns:

the column count. Will be null if undefined.

setColumnCount

public void setColumnCount(int columnCount)

This method sets the columnCount attribute.

Specified by:

setColumnCount in interface AttributeWriteColumnCount

Parameters:

columnCount - is the new value of AttributeReadColumnCount.getColumnCount(). Should be at least 1.

See Also:

AttributeReadColumnCount.getColumnCount()

addChildSpanned

public 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.

Specified by:

addChildSpanned in interface UiWidgetGridPanel

Parameters:

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

Returns:

the created UiWidgetGridRow.

addChildren

public UiWidgetGridRow addChildren(UiWidgetRegular... children)

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

Specified by:

addChildren in interface UiWidgetGridPanel

Parameters:

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

Returns:

the created UiWidgetGridRow.

addSeparatorRow

public 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.

Specified by:

addSeparatorRow in interface UiWidgetGridPanel

getAriaRoleFixedType

protected Class<? extends Role> getAriaRoleFixedType()

Overrides:

getAriaRoleFixedType in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterGridPanel,Void>

Returns:

the Class reflecting the Role that is fixed for this widget or null if the role can be changed dynamically.