com.extjs.gxt.ui.client.widget.form
Class FieldSet

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<T>
                      extended by com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          extended by com.extjs.gxt.ui.client.widget.LayoutContainer
                              extended by com.extjs.gxt.ui.client.widget.form.FieldSet
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class FieldSet
extends LayoutContainer

A container that wraps its content in a HTML fieldset.

Events:
BeforeExpand : FieldSetEvent(fieldSet)
Fires before the panel is expanded. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Expand : FieldSetEvent(fieldSet)
Fires after the panel is expanded
BeforeCollapse : FieldSetEvent(fieldSet)
Fires before the panel is collpased. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Collapse : FieldSetEvent(fieldSet)
Fires after the panel is collapsed.
Inherited Events:
LayoutContainer AfterLayout
ScrollContainer Scroll
Container BeforeAdd
Container Add
Container BeforeRemove
Container Remove
BoxComponent Move
BoxComponent Resize
Component Enable
Component Disable
Component BeforeHide
Component Hide
Component BeforeShow
Component Show
Component Attach
Component Detach
Component BeforeRender
Component Render
Component BrowserEvent
Component BeforeStateRestore
Component StateRestore
Component BeforeStateSave
Component SaveState


Nested Class Summary
 
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 inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
FieldSet()
          Creates a new fieldset.
 
Method Summary
 void collapse()
          Collapses the fieldset.
protected  ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
           
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 void expand()
          Expands the fieldset.
 java.lang.String getCheckboxName()
          Returns the checkbox name.
 java.lang.String getHeading()
          Returns the panel heading.
 El getLayoutTarget()
          Override this method to specify the element to be used by the layout as the container.
 boolean insert(Component item, int index)
          Adds a item into the container.
 boolean isCheckboxToggle()
          Returns true if checkbox toggle is enabled.
 boolean isCollapsible()
          Returns true if the fieldset is collapsible.
 boolean isExpanded()
          Returns true if the panel is expanded.
protected  void notifyHide()
           
protected  void notifyShow()
           
protected  void onClick(ComponentEvent ce)
           
protected  void onCollapse()
           
 void onComponentEvent(ComponentEvent ce)
          Any events a component receives will be forwarded to this method.
protected  void onDisable()
           
protected  void onEnable()
           
protected  void onExpand()
           
protected  void onFocus(ComponentEvent ce)
           
protected  void onRender(com.google.gwt.user.client.Element parent, int pos)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void onResize(int width, int height)
          Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
 void setCheckboxName(java.lang.String checkboxName)
          The name to assign to the fieldset's checkbox if setCheckboxToggle(boolean) = true.
 void setCheckboxToggle(boolean checkboxToggle)
          True to render a checkbox into the fieldset frame just in front of the legend (defaults to false, pre-render).
 void setCollapsible(boolean collapsible)
          Sets whether the fieldset is collapsible (defaults to false, pre-render).
 void setExpanded(boolean expand)
          Sets the panel's expand state.
 void setHeading(java.lang.String text)
          Sets the panel heading.
protected  void updateIconTitles()
           
 
Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer
add, add, addText, findComponent, getLayout, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, onBlur, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay
 
Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer
addScrollListener, afterRender, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
add, adjustIndex, adopt, createContainerEvent, disable, doLayout, doLayout, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, isLayoutNeeded, iterator, onAfterLayout, onAttach, onBeforeLayoutExcecuted, onInsert, onLayoutExcecuted, onRemove, orphan, remove, remove, removeAll, scrollIntoView, setLayoutNeeded, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, onBrowserEvent, onDetach, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FieldSet

public FieldSet()
Creates a new fieldset.

Method Detail

collapse

public void collapse()
Collapses the fieldset.


expand

public void expand()
Expands the fieldset.


getCheckboxName

public java.lang.String getCheckboxName()
Returns the checkbox name.

Returns:
the checkbox name

getHeading

public java.lang.String getHeading()
Returns the panel heading.

Returns:
the heading

getLayoutTarget

public El getLayoutTarget()
Description copied from class: LayoutContainer
Override this method to specify the element to be used by the layout as the container. Allows the container to be decorated.

Overrides:
getLayoutTarget in class LayoutContainer
Returns:
the element to be used as the panel's container

insert

public boolean insert(Component item,
                      int index)
Description copied from class: Container
Adds a item into the container. Fires the BeforeAdd event before inserting, then fires the Add event after the widget has been inserted.

Overrides:
insert in class Container<Component>
Parameters:
item - the item to insert
index - the insert location

isCheckboxToggle

public boolean isCheckboxToggle()
Returns true if checkbox toggle is enabled.

Returns:
the checkbox toggle state

isCollapsible

public boolean isCollapsible()
Returns true if the fieldset is collapsible.

Returns:
true if callapsible

isExpanded

public boolean isExpanded()
Returns true if the panel is expanded.

Returns:
the expand state

onComponentEvent

public void onComponentEvent(ComponentEvent ce)
Description copied from class: Component
Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:
onComponentEvent in class LayoutContainer
Parameters:
ce - the base event

setCheckboxName

public void setCheckboxName(java.lang.String checkboxName)
The name to assign to the fieldset's checkbox if setCheckboxToggle(boolean) = true.

Parameters:
checkboxName - the name

setCheckboxToggle

public void setCheckboxToggle(boolean checkboxToggle)
True to render a checkbox into the fieldset frame just in front of the legend (defaults to false, pre-render). The fieldset will be expanded or collapsed when the checkbox is toggled.

Parameters:
checkboxToggle - true for checkbox toggle

setCollapsible

public void setCollapsible(boolean collapsible)
Sets whether the fieldset is collapsible (defaults to false, pre-render).

Parameters:
collapsible - true for collapse

setExpanded

public void setExpanded(boolean expand)
Sets the panel's expand state.

Parameters:
expand - true true to expand

setHeading

public void setHeading(java.lang.String text)
Sets the panel heading.

Parameters:
text - the heading text

createComponentEvent

protected ComponentEvent createComponentEvent(com.google.gwt.user.client.Event event)
Overrides:
createComponentEvent in class BoxComponent

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Container<Component>

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Container<Component>

notifyHide

protected void notifyHide()
Overrides:
notifyHide in class Container<Component>

notifyShow

protected void notifyShow()
Overrides:
notifyShow in class Container<Component>

onClick

protected void onClick(ComponentEvent ce)

onCollapse

protected void onCollapse()

onDisable

protected void onDisable()
Overrides:
onDisable in class Component

onEnable

protected void onEnable()
Overrides:
onEnable in class Component

onExpand

protected void onExpand()

onFocus

protected void onFocus(ComponentEvent ce)
Overrides:
onFocus in class LayoutContainer

onRender

protected void onRender(com.google.gwt.user.client.Element parent,
                        int pos)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class LayoutContainer
Parameters:
parent - the target element
pos - the insert location

onResize

protected void onResize(int width,
                        int height)
Description copied from class: BoxComponent
Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:
onResize in class BoxComponent
Parameters:
width - the width
height - the height

updateIconTitles

protected void updateIconTitles()