net.sf.mmm.client.ui.gwt.widgets

Class CollapseExpandButton

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.FocusWidget

com.google.gwt.user.client.ui.ButtonBase

com.google.gwt.user.client.ui.Button

net.sf.mmm.client.ui.gwt.widgets.CollapseExpandButton

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents, AttributeReadCollapsed, AttributeWriteCollapsed

public class CollapseExpandButton
extends com.google.gwt.user.client.ui.Button
implements AttributeWriteCollapsed

A CollapseExpandButton is a Button used to collapse and expand a section that is typically located below it.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CollapseExpandButton.CollapseHandler Interface for a handler that gets notified about collapsing and expanding.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	collapsed
private CollapseExpandButton.CollapseHandler	collapseHandler The CollapseExpandButton.CollapseHandler given at construction time.

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CollapseExpandButton(CollapseExpandButton.CollapseHandler collapseHandler) The constructor.

Method Summary

Modifier and Type	Method and Description
private NlsBundleClientUiRoot	getBundle()
boolean	isCollapsed() This method determines if this object is collapsed.
void	setCollapsed(boolean collapsed) This method sets the collapsed status of this object.
void	setCollapsed(boolean newCollapsed, boolean programmatic)

Methods inherited from class com.google.gwt.user.client.ui.Button

click, getButtonElement, wrap

Methods inherited from class com.google.gwt.user.client.ui.ButtonBase

getHTML, getText, setHTML, setHTML, setText

Methods inherited from class com.google.gwt.user.client.ui.FocusWidget

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, getTabIndex, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

collapseHandler

private final CollapseExpandButton.CollapseHandler collapseHandler

The CollapseExpandButton.CollapseHandler given at construction time.

collapsed

private boolean collapsed

See Also:

isCollapsed()

Constructor Detail

CollapseExpandButton

public CollapseExpandButton(CollapseExpandButton.CollapseHandler collapseHandler)

The constructor.

Parameters:

collapseHandler - is the CollapseExpandButton.CollapseHandler notified about collapsing and expanding.

Method Detail

getBundle

private NlsBundleClientUiRoot getBundle()

Returns:

the instance of NlsBundleClientUiRoot.

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 newCollapsed,
                         boolean programmatic)

Parameters:

newCollapsed - - see setCollapsed(boolean).

programmatic - - see UiEvent.isProgrammatic().

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.