com.alkacon.geranium.client.ui

Class FieldSet

java.lang.Object

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

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

com.google.gwt.user.client.ui.Composite

com.alkacon.geranium.client.ui.FieldSet

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<FieldSet>, com.google.gwt.event.logical.shared.HasOpenHandlers<FieldSet>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class FieldSet
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.event.logical.shared.HasOpenHandlers<FieldSet>, com.google.gwt.event.logical.shared.HasCloseHandlers<FieldSet>

A panel that behaves like a HTML fieldset.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	FieldSet.I_CmsFieldSetUiBinder The ui-binder interface for this composite.

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
static int	DEFAULT_ANIMATION_DURATION Default animation duration.
protected com.google.gwt.user.client.ui.FlowPanel	m_content The content of the fieldset.
protected com.google.gwt.user.client.ui.FlowPanel	m_fieldset The wrapping panel for this fieldset.
protected com.google.gwt.user.client.ui.Image	m_image The image for the top and bottom arrow.
protected Label	m_legend The legend of the fieldset.
protected boolean	m_opened Signals whether the fieldset is opened.
protected com.google.gwt.user.client.ui.FlowPanel	m_wrapper The legend of the fieldset.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
FieldSet() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<FieldSet> handler)
void	addContent(com.google.gwt.user.client.ui.Widget w) Adds a widget to this field set.
com.google.gwt.event.shared.HandlerRegistration	addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<FieldSet> handler)
com.google.gwt.user.client.ui.FlowPanel	getContentPanel() Returns the content panel.
int	getWidgetCount() Returns the count of widgets inside this fieldset.
com.google.gwt.user.client.ui.FlowPanel	getWrapper() Returns the wrapper.
protected void	handleClick(com.google.gwt.event.dom.client.ClickEvent e) Adds a click handler to the image icon of this fieldset.
boolean	isOpen() Returns if the fieldset is opened.
void	setAnimationDuration(int animDuration) Sets the animation duration.
void	setLegend(java.lang.String legendText) Sets the text for the legend of this field set.
void	setOpen(boolean open) Sets the fieldset open, showing the content.

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

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

DEFAULT_ANIMATION_DURATION

public static final int DEFAULT_ANIMATION_DURATION

Default animation duration.

See Also:

Constant Field Values

m_content

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_content

The content of the fieldset.

m_fieldset

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_fieldset

The wrapping panel for this fieldset.

m_image

@UiField
protected com.google.gwt.user.client.ui.Image m_image

The image for the top and bottom arrow.

m_legend

@UiField
protected Label m_legend

The legend of the fieldset.

m_opened

protected boolean m_opened

Signals whether the fieldset is opened.

m_wrapper

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_wrapper

The legend of the fieldset.

Constructor Detail

FieldSet

public FieldSet()

Default constructor.

Because this class has a default constructor, it can be used as a binder template. In other words, it can be used in other *.ui.xml files:

Method Detail

addCloseHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<FieldSet> handler)

Specified by:

addCloseHandler in interface com.google.gwt.event.logical.shared.HasCloseHandlers<FieldSet>

See Also:

HasCloseHandlers.addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler)

addContent

public void addContent(com.google.gwt.user.client.ui.Widget w)

Adds a widget to this field set.

Parameters:

w - the widget to add

addOpenHandler

public com.google.gwt.event.shared.HandlerRegistration addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler<FieldSet> handler)

Specified by:

addOpenHandler in interface com.google.gwt.event.logical.shared.HasOpenHandlers<FieldSet>

See Also:

HasOpenHandlers.addOpenHandler(com.google.gwt.event.logical.shared.OpenHandler)

getContentPanel

public com.google.gwt.user.client.ui.FlowPanel getContentPanel()

Returns the content panel.

Returns:

the content panel

getWidgetCount

public int getWidgetCount()

Returns the count of widgets inside this fieldset.

Returns:

the count of widgets inside this fieldset

getWrapper

public com.google.gwt.user.client.ui.FlowPanel getWrapper()

Returns the wrapper.

Returns:

the wrapper

isOpen

public boolean isOpen()

Returns if the fieldset is opened.

Returns:

true if the fieldset is opened

setAnimationDuration

public void setAnimationDuration(int animDuration)

Sets the animation duration.

Parameters:

animDuration - the animation duration

setLegend

public void setLegend(java.lang.String legendText)

Sets the text for the legend of this field set.

Parameters:

legendText - the legend text

setOpen

public void setOpen(boolean open)

Sets the fieldset open, showing the content.

Parameters:

open - true to open the fieldset

handleClick

@UiHandler(value="m_image")
protected void handleClick(com.google.gwt.event.dom.client.ClickEvent e)

Adds a click handler to the image icon of this fieldset.

On click the

Parameters:

e - the event