com.sencha.gxt.widget.core.client

Class Header

java.lang.Object

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

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

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.Header

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, HasSafeHtml, EventListener, HasEnabled, HasHTML, HasText, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasIcon, HasItemId

public class Header
extends Component
implements HasIcon, HasText, HasHTML, HasSafeHtml

A custom widget that supports an icon, text, and tool area.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Header.HeaderAppearance The appearance of a header.

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Header() Creates a header with the default appearance which includes a header bar, text and an icon.
Header(Header.HeaderAppearance appearance) Creates a header with the specified appearance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTool(Widget tool) Adds a tool.
Header.HeaderAppearance	getAppearance() Returns the appearance used to render the header.
String	getHTML()
ImageResource	getIcon() Returns the icon image
String	getIconAltText() Returns the icon's alt text.
String	getText() Returns the header's text.
Widget	getTool(int index) Returns the tool at the given index.
int	getToolCount() Returns the number of tool items.
List<Widget>	getTools() Returns the tool's.
int	indexOf(Widget tool) Returns the index of the given tool.
void	insertTool(Widget tool, int index) Inserts a tool.
void	removeTool(Widget tool) Removes a tool.
void	setHTML(SafeHtml html)
void	setHTML(String html)
void	setIcon(ImageResource icon) Sets the icon.
void	setIconAltText(String altIconText) Sets the header's icon alt text (defaults to null).
void	setText(String text) Sets the header's text.

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Header

public Header()

Creates a header with the default appearance which includes a header bar, text and an icon.

Header

public Header(Header.HeaderAppearance appearance)

Creates a header with the specified appearance.

Parameters:

appearance - the appearance of the header

Method Detail

addTool

public void addTool(Widget tool)

Adds a tool.

Parameters:

tool - the tool to be inserted

getAppearance

public Header.HeaderAppearance getAppearance()

Returns the appearance used to render the header.

Returns:

the header appearance

getHTML

public String getHTML()

Specified by:

getHTML in interface HasHTML

getIcon

public ImageResource getIcon()

Returns the icon image

Specified by:

getIcon in interface HasIcon

Returns:

the icon

getIconAltText

public String getIconAltText()

Returns the icon's alt text.

Returns:

the alt text

getText

public String getText()

Returns the header's text.

Specified by:

getText in interface HasText

Returns:

the text

getTool

public Widget getTool(int index)

Returns the tool at the given index.

Parameters:

index - the index

Returns:

the tool

getToolCount

public int getToolCount()

Returns the number of tool items.

Returns:

the count

getTools

public List<Widget> getTools()

Returns the tool's.

Returns:

the tools

indexOf

public int indexOf(Widget tool)

Returns the index of the given tool.

Parameters:

tool - the tool

Returns:

the index or -1 if no match

insertTool

public void insertTool(Widget tool,
              int index)

Inserts a tool.

Parameters:

tool - the tool to insert

index - the insert location

removeTool

public void removeTool(Widget tool)

Removes a tool.

Parameters:

tool - the tool to remove

setHTML

public void setHTML(SafeHtml html)

Specified by:

setHTML in interface HasSafeHtml

setHTML

public void setHTML(String html)

Specified by:

setHTML in interface HasHTML

setIcon

public void setIcon(ImageResource icon)

Description copied from interface: HasIcon

Sets the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - the icon

setIconAltText

public void setIconAltText(String altIconText)

Sets the header's icon alt text (defaults to null).

Parameters:

altIconText - the icon alt text

setText

public void setText(String text)

Sets the header's text.

Specified by:

setText in interface HasText

Parameters:

text - the new text