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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<T>
                      com.extjs.gxt.ui.client.widget.ScrollContainer<Component>
                          com.extjs.gxt.ui.client.widget.LayoutContainer
                              com.extjs.gxt.ui.client.widget.form.FieldSet

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

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

• fieldSet : this

Expand : FieldSetEvent(fieldSet)

Fires after the panel is expanded

• fieldSet : this

BeforeCollapse : FieldSetEvent(fieldSet)

Fires before the panel is collpased. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• fieldSet : this

Collapse : FieldSetEvent(fieldSet)

Fires after the panel is collapsed.

• fieldSet : this

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.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

FieldSet()
Creates a new fieldset.

Method Summary

void	collapse() Collapses the fieldset.
void	expand() Expands the fieldset.
java.lang.String	getCheckboxName() Returns the checkbox name.
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.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
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.

Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer

add, add, addText, findComponent, getLayout, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay

Methods inherited from class com.extjs.gxt.ui.client.widget.ScrollContainer

addScrollListener, getHScrollPosition, getScrollMode, getVScrollPosition, removeScrollListener, scrollIntoView, setHScrollPosition, setScrollMode, setVScrollPosition

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

disable, enable, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, 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

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

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

fireEvent, getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, 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

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.

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 ScrollContainer<Component>

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