net.sf.mmm.client.ui.impl.gwt.widget.panel.adapter

Class UiWidgetAdapterGwtCollapsableBorderPanel

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<WIDGET>

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtSingleMutableComposite<Fieldset,UiWidgetRegular>

net.sf.mmm.client.ui.impl.gwt.widget.panel.adapter.UiWidgetAdapterGwtBorderPanel

net.sf.mmm.client.ui.impl.gwt.widget.panel.adapter.UiWidgetAdapterGwtCollapsableBorderPanel

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadCollapsed, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAccessKey, AttributeWriteAttribute, AttributeWriteCollapsed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteLabel, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterComposite<UiWidgetRegular>, UiWidgetAdapterSingleComposite<UiWidgetRegular>, UiWidgetAdapterSingleMutableComposite<UiWidgetRegular>, UiWidgetAdapterWithLabel, UiWidgetAdapterAbstractBorderPanel, UiWidgetAdapterBorderPanel, UiWidgetAdapterCollapsableBorderPanel, CollapseExpandButton.CollapseHandler, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, Accessibility

public class UiWidgetAdapterGwtCollapsableBorderPanel
extends UiWidgetAdapterGwtBorderPanel
implements UiWidgetAdapterCollapsableBorderPanel, CollapseExpandButton.CollapseHandler

This is the implementation of UiWidgetAdapterCollapsableBorderPanel using GWT based on Fieldset and CollapseExpandButton.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private CollapseExpandButton	collapseExpandButton The CollapseExpandButton for user interaction.

Fields inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

TAB_INDEX_NONE

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

PROPERTY_LABEL

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtCollapsableBorderPanel() The constructor.

Method Summary

Modifier and Type	Method and Description
boolean	isCollapsed() This method determines if this object is collapsed.
void	onCollapse(boolean collapse, boolean programmatic) This method is called to notify about collapsing and expanding.
void	setAccessKey(char accessKey) This method sets the accessKey attribute of this object.
void	setCollapsed(boolean collapsed) This method sets the collapsed status of this object.
void	setEnabled(boolean enabled) This method sets the enabled status of this object.
boolean	setFocused() This method sets the focus to this object.

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.panel.adapter.UiWidgetAdapterGwtBorderPanel

createToplevelWidget, setChild, setLabel

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget

dispose, getActiveWidget, removeFromParent

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

addHandlerRegistration, addStyle, createAbsoluteImageUrl, createEventAdapter, getHeightInPixel, getImage, getImageParentElement, getLength, getSizeElement, getToplevelWidget, getToplevelWidget, getWidthInPixel, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setLength, setPrimaryStyle, setStyles, setTooltip, setVisible

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

applyEventAdapter, applyEventAdapterForChange, applyEventAdapterForClick, applyEventAdapterForFocus, applyEventAdapterForSelection, getEventAdapter, setEventSender

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

createLabel, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, isResizable, setMode, setParent, setUiWidget

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapterSingleComposite

setChild

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createAbsoluteImageUrl, createLabel, getToplevelWidget, isStyleDeltaSupported, removeFromParent, setEventSender, setMode, setParent, setVisible

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

setLength

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

getLength

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

getHeightInPixel, getWidthInPixel

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

getAttribute

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

setAttribute

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

isFocused

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

getAccessKey

Field Detail

collapseExpandButton

private final CollapseExpandButton collapseExpandButton

The CollapseExpandButton for user interaction.

Constructor Detail

UiWidgetAdapterGwtCollapsableBorderPanel

public UiWidgetAdapterGwtCollapsableBorderPanel()

The constructor.

Method Detail

setEnabled

public void setEnabled(boolean enabled)

This method sets the enabled status of this object. If it is disabled, the user can not interact with the object.

Specified by:

setEnabled in interface AttributeWriteEnabled

Overrides:

setEnabled in class UiWidgetAdapterGwtBorderPanel

Parameters:

enabled - - if true the object will be enabled, else the object will be disabled.

setFocused

public boolean setFocused()

This method sets the focus to this object.
NOTE:
You can only set the focus. To actually remove it, you need to set it in a different widget. Further, as an API user you can normally ignore the result. This is only relevant for composite widgets such as panels, that delegate the call recursively and may not contain any child that can take the focus.

Specified by:

setFocused in interface AttributeWriteOnlyFocused

Returns:

true if the focus has been set successfully, false otherwise.

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.

setAccessKey

public void setAccessKey(char accessKey)

This method sets the accessKey attribute of this object.

Specified by:

setAccessKey in interface AttributeWriteAccessKey

Parameters:

accessKey - is the new value of AttributeReadAccessKey.getAccessKey(). Use AttributeReadAccessKey.ACCESS_KEY_NONE to unset.

onCollapse

public void onCollapse(boolean collapse,
                       boolean programmatic)

This method is called to notify about collapsing and expanding. It has to implement the logic that actually shows and hides things accordingly.

Specified by:

onCollapse in interface CollapseExpandButton.CollapseHandler

Parameters:

collapse - - true if switched to collapsed state, false if switched to expanded state.

programmatic - - see UiEvent.isProgrammatic().