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

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

All Implemented Interfaces:

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

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

• tabPanel : this
• item : the item that was closed.

Close : TabPanelEvent(tabPanel, item)

Fires after an item is closed by the user clicking the close icon.

• tabPanel : this
• item : the item that was closed.

Select : TabPanelEvent(tabPanel, item)

Fires after the item is selected.

• tabPanel : this
• item : the item that was closed.

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

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.
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, remove, removeAll, setLayout, setLayoutData, setLayoutOnChange, setMonitorWindowResize, setWindowResizeDelay

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

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

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

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

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