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

Class AbstractUiWidgetCollapsableBorderPanel<ADAPTER extends UiWidgetAdapterCollapsableBorderPanel>

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.AbstractUiWidgetSingleComposite<ADAPTER,CHILD>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetSingleMutableComposite<ADAPTER,UiWidgetRegular>

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

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

Type Parameters:

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

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadCollapsed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<Void>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureCollapse, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<Void>, UiFeatureValue<Void>, UiFeatureValueAndValidation<Void>, UiWidgetAbstractBorderPanel, UiWidgetCollapsableBorderPanel, UiWidgetPanel<UiWidgetRegular>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<Void>, UiWidgetComposite<UiWidgetRegular>, UiWidgetNative, UiWidgetRegular, UiWidgetRegularComposite<UiWidgetRegular>, UiWidgetSingleComposite<UiWidgetRegular>, UiWidgetSingleMutableComposite<UiWidgetRegular>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

UiWidgetCollapsableBorderPanelGwt

public abstract class AbstractUiWidgetCollapsableBorderPanel<ADAPTER extends UiWidgetAdapterCollapsableBorderPanel>
extends AbstractUiWidgetAbstractBorderPanel<ADAPTER>
implements UiWidgetCollapsableBorderPanel

This is the abstract base implementation of UiWidgetCollapsableBorderPanel.

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 boolean	collapsed

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

STYLE_BORDER_PANEL

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.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetCollapsableBorderPanel(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.
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.
protected void	onChildRemoved(UiWidgetRegular oldChild)
protected void	onChildSet(UiWidgetRegular newChild)
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.
void	setCollapsed(boolean collapsedFlag, boolean programmatic, boolean fromAdapter)

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

getLabel, setLabel

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

setChild

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

doSetChild, getChild, getChild, getChildCount, getChildIndex

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, getAriaRole, getAriaRoleFixedType, 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.panel.UiWidgetAbstractBorderPanel

setChild

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

getChild, getChildCount

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

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.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.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()

Constructor Detail

AbstractUiWidgetCollapsableBorderPanel

public AbstractUiWidgetCollapsableBorderPanel(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 AbstractUiWidgetAbstractBorderPanel<ADAPTER extends UiWidgetAdapterCollapsableBorderPanel>

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

public void setCollapsed(boolean collapsedFlag,
                         boolean programmatic,
                         boolean fromAdapter)

Parameters:

collapsedFlag - - see setCollapsed(boolean).

programmatic - - see UiEvent.isProgrammatic().

fromAdapter - - true if this method is called from the widget adapter, false if called from this UiWidget.

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.

onChildRemoved

protected void onChildRemoved(UiWidgetRegular oldChild)

Overrides:

onChildRemoved in class AbstractUiWidgetSingleComposite<ADAPTER extends UiWidgetAdapterCollapsableBorderPanel,UiWidgetRegular>

Parameters:

oldChild - is the child that has just been removed.

onChildSet

protected void onChildSet(UiWidgetRegular newChild)

Overrides:

onChildSet in class AbstractUiWidgetSingleComposite<ADAPTER extends UiWidgetAdapterCollapsableBorderPanel,UiWidgetRegular>

Parameters:

newChild - is the child that has just been set.