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

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.TabItem
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 TabItem
extends LayoutContainer
implements IconSupport

TabItems are added to a TabPanel. TabItems can be closable, disabled and support icons. Code snippet:

 TabItem ti = new TabItem("Tab One");
 ti.setClosable(true);
 ti.setEnabled(false);
 tabPanel.add(ti);
 
Events:
BeforeClose : TabPanelEvent(tabPanel, item)
Fires before an item is closed by the user clicking the close icon. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).
Close : TabPanelEvent(tabPanel, item)
Fires after an item is closed by the user clicking the close icon.
Select : TabPanelEvent(tabPanel, item)
Fires after the item is selected.


Nested Class Summary
 class TabItem.HeaderItem
           
 
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  TabItem.HeaderItem header
           
protected  TabPanel tabPanel
           
protected  Template template
           
 
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
TabItem()
          Creates a new tab item.
TabItem(java.lang.String text)
          Creates a new tab item with the given text.
 
Method Summary
 void close()
          Closes the tab item.
 void disable()
          Disable this component.
 void enable()
          Enable this component.
 TabItem.HeaderItem getHeader()
          Returns the item's header component.
 com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()
          Returns the item's icon style.
 TabPanel getTabPanel()
          Returns the item's tab panel.
 java.lang.String getText()
          Returns the item's text.
 java.lang.String getTextStyle()
          Returns the item's text style name.
 boolean isClosable()
          Returns true if the item can be closed.
protected  void onRender(com.google.gwt.user.client.Element parent, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void setAutoLoad(com.google.gwt.http.client.RequestBuilder requestBuilder)
          Sends a remote request and sets the item's content using the returned HTML.
 void setClosable(boolean closable)
          Sets whether the tab may be closed (defaults to false).
 void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)
          Sets the item's icon.
 void setIconStyle(java.lang.String icon)
          Sets the icon style.
 void setText(java.lang.String text)
          Sets the item's text.
 void setTextStyle(java.lang.String textStyle)
          Sets the style name to be applied to the item's text element.
 com.google.gwt.user.client.ui.Frame setUrl(java.lang.String url)
          Sets a url for the content area of the item.
 java.lang.String toString()
           
 
Methods inherited from class com.extjs.gxt.ui.client.widget.LayoutContainer
add, add, addText, findComponent, getLayout, getLayoutTarget, getWindowResizeDelay, insert, insert, isLayoutOnChange, isMonitorWindowResize, layout, layout, onBlur, onComponentEvent, onFocus, 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, doAttachChildren, doDetachChildren, doLayout, doLayout, findItem, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, insert, isLayoutNeeded, iterator, notifyHide, notifyShow, 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, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, 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, onDisable, onEnable, 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, 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
 

Field Detail

template

protected Template template

tabPanel

protected TabPanel tabPanel

header

protected TabItem.HeaderItem header
Constructor Detail

TabItem

public TabItem()
Creates a new tab item.


TabItem

public TabItem(java.lang.String text)
Creates a new tab item with the given text.

Parameters:
text - the item's text
Method Detail

close

public void close()
Closes the tab item.


disable

public void disable()
Description copied from class: Component
Disable this component. Fires the Disable event.

Overrides:
disable in class Container<Component>

enable

public void enable()
Description copied from class: Component
Enable this component. Fires the Enable event.

Overrides:
enable in class Container<Component>

getHeader

public TabItem.HeaderItem getHeader()
Returns the item's header component.

Returns:
the header component

getIcon

public com.google.gwt.user.client.ui.AbstractImagePrototype getIcon()
Returns the item's icon style.

Specified by:
getIcon in interface IconSupport
Returns:
the icon style

getTabPanel

public TabPanel getTabPanel()
Returns the item's tab panel.

Returns:
the tab panel

getText

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

Returns:
the text

getTextStyle

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

Returns:
the style name

isClosable

public boolean isClosable()
Returns true if the item can be closed.

Returns:
the closable the close state

setAutoLoad

public void setAutoLoad(com.google.gwt.http.client.RequestBuilder requestBuilder)
Sends a remote request and sets the item's content using the returned HTML.

Parameters:
requestBuilder - the request builder

setClosable

public void setClosable(boolean closable)
Sets whether the tab may be closed (defaults to false).

Parameters:
closable - the closable state

setIcon

public void setIcon(com.google.gwt.user.client.ui.AbstractImagePrototype icon)
Sets the item's icon.

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 item's text.

Parameters:
text - the new text

setTextStyle

public void setTextStyle(java.lang.String textStyle)
Sets the style name to be applied to the item's text element.

Parameters:
textStyle - the style name

setUrl

public com.google.gwt.user.client.ui.Frame setUrl(java.lang.String url)
Sets a url for the content area of the item.

Parameters:
url - the url
Returns:
the frame widget

toString

public java.lang.String toString()
Overrides:
toString in class Component

onRender

protected void onRender(com.google.gwt.user.client.Element parent,
                        int index)
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
index - the insert location