com.extjs.gxt.ui.client.widget
Class Header

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.Header
All Implemented Interfaces:
Observable, IconSupport, 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 Header
extends Component
implements IconSupport

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


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
protected  com.google.gwt.user.client.ui.AbstractImagePrototype icon
           
 
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
Header()
           
 
Method Summary
 void addTool(Component tool)
          Adds a tool.
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()
          Returns the icon.
 java.lang.String getIconAltText()
          Returns the icon's alt text.
 java.lang.String getText()
          Returns the header's text.
 java.lang.String getTextStyle()
          Returns the item's text style.
 Component getTool(int index)
          Returns the tool at the given index.
 int getToolCount()
          Returns the number of tool items.
 java.util.List<Component> getTools()
          Returns the tool's.
 int indexOf(Component tool)
          Returns the index of the given tool.
 void insertTool(Component tool, int index)
          Inserts a tool.
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void removeTool(Component tool)
          Removes a tool.
 void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)
          Sets the header's icon style.
 void setIconAltText(java.lang.String altIconText)
          Sets the header's icon alt text (defaults to null).
 void setIconStyle(java.lang.String icon)
          Sets the icon style.
 void setText(java.lang.String text)
          Sets the header's text.
 void setTextStyle(java.lang.String textStyle)
          Sets the style name added to the header's text element.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, afterRender, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createComponentEvent, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, 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, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onBrowserEvent, onComponentEvent, onDetach, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHide, onHideContextMenu, onLoad, onRightClick, onShow, 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, setHeight, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setPixelSize, setSize, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWidth, setWindowResizeDelay, 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, onUnload, 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
 

Field Detail

icon

protected com.google.gwt.user.client.ui.AbstractImagePrototype icon
Constructor Detail

Header

public Header()
Method Detail

addTool

public void addTool(Component tool)
Adds a tool.

Parameters:
tool - the tool to be inserted

getIcon

public com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()
Description copied from interface: IconSupport
Returns the icon.

Specified by:
getIcon in interface IconSupport
Returns:
the icon

getText

public java.lang.String getText()
Returns the header's text.

Returns:
the text

getTextStyle

public java.lang.String getTextStyle()
Returns the item's text style.

Returns:
the textStyle the text style

getIconAltText

public java.lang.String getIconAltText()
Returns the icon's alt text.

Returns:
the alt text

setIconAltText

public void setIconAltText(java.lang.String altIconText)
Sets the header's icon alt text (defaults to null).

Parameters:
altIconText - the icon alt text

getTool

public Component 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 java.util.List<Component> getTools()
Returns the tool's.

Returns:
the tools

indexOf

public int indexOf(Component tool)
Returns the index of the given tool.

Parameters:
tool - the tool
Returns:
the index or -1 if no match

insertTool

public void insertTool(Component tool,
                       int index)
Inserts a tool.

Parameters:
tool - the tool to insert
index - the insert location

removeTool

public void removeTool(Component tool)
Removes a tool.

Parameters:
tool - the tool to remove

setIcon

public void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)
Sets the header's icon style. The style name should match a CSS style that specifies a background image using the following format:
 <code>
 .my-icon {
    background: url(images/icons/my-icon.png) no-repeat center left !important;
 }
 </code>
 

Specified by:
setIcon in interface IconSupport
Parameters:
icon - the icon

setIconStyle

public void setIconStyle(java.lang.String icon)
Description copied from interface: IconSupport
Sets the icon style.

Specified by:
setIconStyle in interface IconSupport
Parameters:
icon - a CSS style name

setText

public void setText(java.lang.String text)
Sets the header's text.

Parameters:
text - the new text

setTextStyle

public void setTextStyle(java.lang.String textStyle)
Sets the style name added to the header's text element.

Parameters:
textStyle - the text style

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Component

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Component

onRender

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

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location