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

Class AbstractUiWidgetCollapsableSection<ADAPTER extends UiWidgetAdapterCollapsableSection>

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,VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

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

net.sf.mmm.client.ui.base.widget.core.AbstractUiWidgetCollapsableSection<ADAPTER>

Type Parameters:

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

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadCollapsed, AttributeReadEnabled, AttributeReadFocused, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<Void>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureClick, UiFeatureCollapse, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<Void>, UiFeatureValue<Void>, UiFeatureValueAndValidation<Void>, UiWidgetCollapsableSection, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<Void>, UiWidgetActive, UiWidgetClickable, UiWidgetNative, UiWidgetRegular, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl

public abstract class AbstractUiWidgetCollapsableSection<ADAPTER extends UiWidgetAdapterCollapsableSection>
extends AbstractUiWidgetClickable<ADAPTER,Void>
implements UiWidgetCollapsableSection

This is the abstract base implementation of UiWidgetCollapsableSection.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AbstractUiWidgetCollapsableSection.CollapseHandler

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 boolean	collapsed
private AbstractUiWidgetCollapsableSection.CollapseHandler	collapseHandler

Fields inherited from interface net.sf.mmm.client.ui.api.widget.core.UiWidgetCollapsableSection

STYLE_COLLAPSE_BUTTON, STYLE_COLLAPSED, STYLE_PRIMARY

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

PROPERTY_LABEL

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

STYLE_HEADER

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

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

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

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addCollapseHandler(UiHandlerEventCollapse handler) This method adds the given UiHandlerEventCollapse to this object.
void	addCollapseWidget(UiWidget widget) Adds a collapse handler that triggers the AttributeWriteVisibleAdvanced.getVisibleFlag() visibility} of the given UiWidget.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
boolean	isCollapsed() This method determines if this object is collapsed.
boolean	removeCollapseHandle(UiHandlerEventCollapse handler) This method removes the given UiHandlerEventCollapse from this object.
void	setCollapsed(boolean collapsed) This method sets the collapsed status of this object.
protected void	setCollapsed(boolean collapsedFlag, boolean programmatic)

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

addClickHandler, click, click, getImage, getLabel, getSource, onAccessKeyPressed, removeClickHandler, setImage, setLabel, toString

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

addFocusHandler, getAccessKey, isFocused, removeFocusHandler, setAccessKey, setFocused, setFocused

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

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, 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, 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.attribute.AttributeWriteLabel

setLabel

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

getLabel

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

getContext, getParent, getSize

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

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

setMode

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

getMode

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

setModeFixed

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

getModeFixed

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

setId

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

getId

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

setTooltip

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

getTooltip

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

getVisibleFlag, isVisible, setVisible, setVisible

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

isVisibleRecursive

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

setEnabled

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

isEnabled

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

addStyle, removeStyle

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

hasStyle

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

setStyles

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

getStyles

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

setPrimaryStyle

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

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

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

isModified

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

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

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

setAccessKey

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

getAccessKey

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureFocus

addFocusHandler, removeFocusHandler

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

isFocused

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

setFocused

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

collapsed

private boolean collapsed

See Also:

isCollapsed()

collapseHandler

private AbstractUiWidgetCollapsableSection.CollapseHandler collapseHandler

See Also:

addCollapseWidget(UiWidget)

Constructor Detail

AbstractUiWidgetCollapsableSection

public AbstractUiWidgetCollapsableSection(UiContext context,
                                          ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

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

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetClickable<ADAPTER extends UiWidgetAdapterCollapsableSection,Void>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

isCollapsed

public boolean isCollapsed()

This method determines if this object is collapsed. This means that some content is hidden (folded away). If it is NOT collapsed, it is called expanded and the content gets visible again.

Specified by:

isCollapsed in interface AttributeReadCollapsed

Returns:

true if this object is collapsed, false if expanded.

setCollapsed

public void setCollapsed(boolean collapsed)

This method sets the collapsed status of this object.

Specified by:

setCollapsed in interface AttributeWriteCollapsed

Parameters:

collapsed - - if true the object will be collapsed, else it will be expanded.

setCollapsed

protected void setCollapsed(boolean collapsedFlag,
                            boolean programmatic)

Parameters:

collapsedFlag - - see setCollapsed(boolean).

programmatic - - see UiEvent.isProgrammatic().

See Also:

setCollapsed(boolean)

addCollapseHandler

public void addCollapseHandler(UiHandlerEventCollapse handler)

This method adds the given UiHandlerEventCollapse to this object.

Specified by:

addCollapseHandler in interface UiFeatureCollapse

Parameters:

handler - is the UiHandlerEventCollapse to add.

removeCollapseHandle

public boolean removeCollapseHandle(UiHandlerEventCollapse handler)

This method removes the given UiHandlerEventCollapse from this object.

Specified by:

removeCollapseHandle in interface UiFeatureCollapse

Parameters:

handler - is the UiHandlerEventCollapse to remove.

Returns:

true if the handler has been removed successfully, false if it was NOT registered and nothing has changed.

addCollapseWidget

public void addCollapseWidget(UiWidget widget)

Adds a collapse handler that triggers the AttributeWriteVisibleAdvanced.getVisibleFlag() visibility} of the given UiWidget. On collapse the UiWidget will be hidden, on expand it will be shown (or more precisely its visible state will be restored).

Specified by:

addCollapseWidget in interface UiWidgetCollapsableSection

Parameters:

widget - is the widget to add.