public final class

DisclosurePanel

extends Composite
implements HasCloseHandlers<T> HasOpenHandlers<T> FiresDisclosureEvents HasAnimation HasWidgets

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

Class Overview

A widget that consists of a header and a content panel that discloses the content when a user clicks on the header.

CSS Style Rules

.gwt-DisclosurePanel: the panel's primary style
.gwt-DisclosurePanel-open: dependent style set when panel is open
.gwt-DisclosurePanel-closed: dependent style set when panel is closed

The header and content sections can be easily selected using css with a child selector:
.gwt-DisclosurePanel-open .header { ... }

Use in UiBinder Templates

DisclosurePanel elements in UiBinder templates can have one widget child and one of two types of header elements. A <g:header> element can hold text (not html), or a <g:customHeader> element can hold a widget. (Note that the tags of the header elements are not capitalized. This is meant to signal that the header is not a runtime object, and so cannot have a ui:field attribute.)

For example:

 <g:DisclosurePanel>
   <g:header>Text header</g:header>
   <g:Label>Widget body</g:Label>
 </g:DisclosurePanel>

 <g:DisclosurePanel>
   <g:customHeader>
     <g:Label>Widget header</g:Label>
   </g:customHeader>
   <g:Label>Widget body</g:Label>
 </g:DisclosurePanel>

Summary

[Expand]

Inherited Constants

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

Public Constructors
	DisclosurePanel() Creates an empty DisclosurePanel that is initially closed.
	DisclosurePanel(DisclosurePanelImages images, String headerText, boolean isOpen) This constructor is deprecated. use `DisclosurePanel(ImageResource, ImageResource, String)` and `setOpen(boolean)`
	DisclosurePanel(ImageResource openImage, ImageResource closedImage, String headerText) Creates a DisclosurePanel with the specified header text, an initial open/close state and a bundle of images to be used in the default header widget.
	DisclosurePanel(String headerText) Creates a DisclosurePanel that will be initially closed using the specified text in the header.
	DisclosurePanel(String headerText, boolean isOpen) This constructor is deprecated. use `DisclosurePanel(String)` and `setOpen(boolean)`
	DisclosurePanel(Widget header) This constructor is deprecated. use `DisclosurePanel()` and `setHeader(Widget)`
	DisclosurePanel(Widget header, boolean isOpen) This constructor is deprecated. use `DisclosurePanel()`, `setOpen(boolean)` and `setHeader(Widget)` instead

Public Methods
void	add(Widget w) Adds a child widget.
HandlerRegistration	addCloseHandler(CloseHandler<DisclosurePanel> handler)
void	addEventHandler(DisclosureHandler handler) This method is deprecated. Use `addOpenHandler(OpenHandler)` and `addCloseHandler(CloseHandler)` instead
HandlerRegistration	addOpenHandler(OpenHandler<DisclosurePanel> handler)
void	clear() Removes all child widgets.
Widget	getContent() Gets the widget that was previously set in `setContent(Widget)`.
Widget	getHeader() Gets the widget that is currently being used as a header.
HasText	getHeaderTextAccessor() Gets a `HasText` instance to provide access to the headers's text, if the header widget does provide such access.
boolean	isAnimationEnabled() Returns true if animations are enabled, false if not.
boolean	isOpen() Determines whether the panel is open.
Iterator<Widget>	iterator() Gets an iterator for the contained widgets.
boolean	remove(Widget w) Removes a child widget.
void	removeEventHandler(DisclosureHandler handler) This method is deprecated. Use the `removeHandler()` method on the object returned by an addHandler method instead*
void	setAnimationEnabled(boolean enable) Enable or disable animations.
void	setContent(Widget content) Sets the content widget which can be opened and closed by this panel.
void	setHeader(Widget headerWidget) Sets the widget used as the header for the panel.
void	setOpen(boolean isOpen) Changes the visible state of this `DisclosurePanel`.

Protected Methods
void	onEnsureDebugId(String baseID) Affected Elements: -header = the clickable header.

[Expand]

Inherited Methods

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

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

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasCloseHandlers

From interface com.google.gwt.event.logical.shared.HasOpenHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.FiresDisclosureEvents

From interface com.google.gwt.user.client.ui.HasAnimation

From interface com.google.gwt.user.client.ui.HasWidgets

From interface com.google.gwt.user.client.ui.IsWidget

From interface java.lang.Iterable

Public Constructors

public DisclosurePanel ()

Creates an empty DisclosurePanel that is initially closed.

public DisclosurePanel (DisclosurePanelImages images, String headerText, boolean isOpen)

This constructor is deprecated.
use DisclosurePanel(ImageResource, ImageResource, String) and setOpen(boolean)

Creates a DisclosurePanel with the specified header text, an initial open/close state and a bundle of images to be used in the default header widget.

Parameters

images	a bundle that provides disclosure panel specific images
headerText	the text to be displayed in the header
isOpen	the initial open/close state of the content panel

public DisclosurePanel (ImageResource openImage, ImageResource closedImage, String headerText)

Creates a DisclosurePanel with the specified header text, an initial open/close state and a bundle of images to be used in the default header widget.

Parameters

openImage	the open state image resource
closedImage	the closed state image resource
headerText	the text to be displayed in the header

public DisclosurePanel (String headerText)

Creates a DisclosurePanel that will be initially closed using the specified text in the header.

Parameters

headerText	the text to be displayed in the header

public DisclosurePanel (String headerText, boolean isOpen)

This constructor is deprecated.
use DisclosurePanel(String) and setOpen(boolean)

Creates a DisclosurePanel with the specified header text and an initial open/close state.

Parameters

headerText	the text to be displayed in the header
isOpen	the initial open/close state of the content panel

public DisclosurePanel (Widget header)

This constructor is deprecated.
use DisclosurePanel() and setHeader(Widget)

Creates a DisclosurePanel that will be initially closed using a widget as the header.

Parameters

header	the widget to be used as a header

public DisclosurePanel (Widget header, boolean isOpen)

This constructor is deprecated.
use DisclosurePanel(), setOpen(boolean) and setHeader(Widget) instead

Creates a DisclosurePanel using a widget as the header and an initial open/close state.

Parameters

header	the widget to be used as a header
isOpen	the initial open/close state of the content panel

Public Methods

public void add (Widget w)

Adds a child widget.

Parameters

w	the widget to be added

public HandlerRegistration addCloseHandler (CloseHandler<DisclosurePanel> handler)

public void addEventHandler (DisclosureHandler handler)

This method is deprecated.
Use addOpenHandler(OpenHandler) and addCloseHandler(CloseHandler) instead

Attaches an event handler to the panel to receive DisclosureEvent notification.

Parameters

handler	the handler to be added (should not be null)

public HandlerRegistration addOpenHandler (OpenHandler<DisclosurePanel> handler)

public void clear ()

Removes all child widgets.

public Widget getContent ()

Gets the widget that was previously set in setContent(Widget).

Returns

the panel's current content widget

public Widget getHeader ()

Gets the widget that is currently being used as a header.

Returns

the widget currently being used as a header

public HasText getHeaderTextAccessor ()

Gets a HasText instance to provide access to the headers's text, if the header widget does provide such access.

Returns

a reference to the header widget if it implements HasText, null otherwise

public boolean isAnimationEnabled ()

Returns true if animations are enabled, false if not.

public boolean isOpen ()

Determines whether the panel is open.

Returns

true if panel is in open state

public Iterator<Widget> iterator ()

Gets an iterator for the contained widgets. This iterator is required to implement remove().

public boolean remove (Widget w)

Removes a child widget.

Parameters

w	the widget to be removed

Returns

true if the widget was present

public void removeEventHandler (DisclosureHandler handler)

This method is deprecated.
Use the removeHandler() method on the object returned by an add*Handler method instead

Removes an event handler from the panel.

Parameters

handler	the handler to be removed

public void setAnimationEnabled (boolean enable)

Enable or disable animations.

Parameters

enable	true to enable, false to disable

public void setContent (Widget content)

Sets the content widget which can be opened and closed by this panel. If there is a preexisting content widget, it will be detached.

Parameters

content	the widget to be used as the content panel

public void setHeader (Widget headerWidget)

Sets the widget used as the header for the panel.

Parameters

headerWidget	the widget to be used as the header

public void setOpen (boolean isOpen)

Changes the visible state of this DisclosurePanel.

Parameters

isOpen	`true` to open the panel, `false` to close

Protected Methods

protected void onEnsureDebugId (String baseID)

Affected Elements:

-header = the clickable header.

Parameters

baseID	the base ID used by the main element

Interfaces

Classes

Annotations

Enums

Exceptions

DisclosurePanel

Class Overview

CSS Style Rules

Use in UiBinder Templates

Summary

Public Constructors

public DisclosurePanel ()

public DisclosurePanel (DisclosurePanelImages images, String headerText, boolean isOpen)

Parameters

public DisclosurePanel (ImageResource openImage, ImageResource closedImage, String headerText)

Parameters

public DisclosurePanel (String headerText)

Parameters

public DisclosurePanel (String headerText, boolean isOpen)

Parameters

public DisclosurePanel (Widget header)

Parameters

public DisclosurePanel (Widget header, boolean isOpen)

Parameters

Public Methods

public void add (Widget w)

Parameters

public HandlerRegistration addCloseHandler (CloseHandler<DisclosurePanel> handler)

public void addEventHandler (DisclosureHandler handler)

Parameters

public HandlerRegistration addOpenHandler (OpenHandler<DisclosurePanel> handler)

public void clear ()

public Widget getContent ()

Returns

public Widget getHeader ()

Returns

public HasText getHeaderTextAccessor ()

Returns

public boolean isAnimationEnabled ()

public boolean isOpen ()

Returns

public Iterator<Widget> iterator ()

public boolean remove (Widget w)

Parameters

Returns

public void removeEventHandler (DisclosureHandler handler)

Parameters

public void setAnimationEnabled (boolean enable)

Parameters

public void setContent (Widget content)

Parameters

public void setHeader (Widget headerWidget)

Parameters

public void setOpen (boolean isOpen)

Parameters

Protected Methods

protected void onEnsureDebugId (String baseID)

Parameters

See Also