org.exoplatform.gwtframework.ui.client.tab
Class TabPanel

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.TabPanel
                  com.google.gwt.user.client.ui.DecoratedTabPanel
                      org.exoplatform.gwtframework.ui.client.tab.TabPanel

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers<java.lang.Integer>, com.google.gwt.event.logical.shared.HasSelectionHandlers<java.lang.Integer>, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.RequiresResize, com.google.gwt.user.client.ui.SourcesTabEvents, com.google.gwt.user.client.ui.TabListener, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, CloseTabHandler, HasCloseTabHandler, HasTabClosedHandler, Scrollable

public class TabPanel
extends com.google.gwt.user.client.ui.DecoratedTabPanel
implements Scrollable, CloseTabHandler, HasCloseTabHandler, HasTabClosedHandler, com.google.gwt.user.client.ui.RequiresResize

Decorated TabPanel with styled TabBar Created by The eXo Platform SAS .

Version:

$

Author:

Vitaliy Gulyy

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

TabPanel()
Creates new instance of TabPanel.

Method Summary

void	add(com.google.gwt.user.client.ui.Widget w) To add a new Tab to this TabPanel use addTab(...) method.
void	add(com.google.gwt.user.client.ui.Widget w, java.lang.String tabText) To add a new Tab to this TabPanel use addTab(...) method.
void	add(com.google.gwt.user.client.ui.Widget w, java.lang.String tabText, boolean asHTML) To add a new Tab to this TabPanel use addTab(...) method.
void	add(com.google.gwt.user.client.ui.Widget w, com.google.gwt.user.client.ui.Widget tabWidget) To add a new Tab to this TabPanel use addTab(...) method.
com.google.gwt.event.shared.HandlerRegistration	addCloseTabHandler(CloseTabHandler closeTabHandler) Adds CloseTabHandler.
void	addTab(java.lang.String tabId, com.google.gwt.user.client.ui.Image icon, java.lang.String tabText, com.google.gwt.user.client.ui.Widget widget, boolean canClose)
void	addTabButton(com.google.gwt.user.client.ui.Widget button) Adds user defined button to this TabPanel.
com.google.gwt.event.shared.HandlerRegistration	addTabClosedHandler(TabClosedHandler tabClosedHandler)
java.lang.String	getSelectedTabID() Gets the ID of selected tab.
java.lang.String	getTabIdByIndex(int tabIndex) Gets tab's ID through its index.
void	onCloseTab(CloseTabEvent event)
void	onResize()
boolean	remove(int index)
boolean	remove(com.google.gwt.user.client.ui.Widget widget)
void	removeTab(java.lang.String tabId) Removes tab with specified Tab Id.
void	removeTabButton(com.google.gwt.user.client.ui.Widget tabButton) Removes user defined button from this TabPanel.
void	scrollLeft() Scroll TabBar to the left.
void	scrollRight() Scroll TabBar to the right.
void	selectTab(java.lang.String tabId) Selects tab with specified ID.
void	setTabHighlited(int tabIndex, boolean isHighlited)
void	setTabIcon(java.lang.String tabId, com.google.gwt.user.client.ui.Image icon)
void	setTabTitle(java.lang.String tabId, java.lang.String title)
void	setWrapperBorderSize(int wrapperBorderSize)

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

createTabTextWrapper

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

add, add, add, addBeforeSelectionHandler, addSelectionHandler, addTabListener, clear, getDeckPanel, getTabBar, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, insert, insert, insert, insert, isAnimationEnabled, iterator, onBeforeTabSelected, onEnsureDebugId, onTabSelected, removeTabListener, selectTab, selectTab, setAnimationEnabled

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

TabPanel

public TabPanel()

Creates new instance of TabPanel.

Method Detail

add

public void add(com.google.gwt.user.client.ui.Widget w)

To add a new Tab to this TabPanel use addTab(...) method.

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

add in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.add(com.google.gwt.user.client.ui.Widget)

add

public void add(com.google.gwt.user.client.ui.Widget w,
                java.lang.String tabText)

To add a new Tab to this TabPanel use addTab(...) method.

Overrides:

add in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.add(com.google.gwt.user.client.ui.Widget, java.lang.String)

add

public void add(com.google.gwt.user.client.ui.Widget w,
                java.lang.String tabText,
                boolean asHTML)

To add a new Tab to this TabPanel use addTab(...) method.

Overrides:

add in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.add(com.google.gwt.user.client.ui.Widget, java.lang.String, boolean)

add

public void add(com.google.gwt.user.client.ui.Widget w,
                com.google.gwt.user.client.ui.Widget tabWidget)

To add a new Tab to this TabPanel use addTab(...) method.

Overrides:

add in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.add(com.google.gwt.user.client.ui.Widget, com.google.gwt.user.client.ui.Widget)

addCloseTabHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseTabHandler(CloseTabHandler closeTabHandler)

Adds CloseTabHandler.

Specified by:

addCloseTabHandler in interface HasCloseTabHandler

See Also:

HasCloseTabHandler.addCloseTabHandler(org.exoplatform.gwtframework.ui.client.tab.event.CloseTabHandler)

addTabButton

public void addTabButton(com.google.gwt.user.client.ui.Widget button)

Adds user defined button to this TabPanel.

Parameters:

button - new button

setWrapperBorderSize

public void setWrapperBorderSize(int wrapperBorderSize)

addTab

public void addTab(java.lang.String tabId,
                   com.google.gwt.user.client.ui.Image icon,
                   java.lang.String tabText,
                   com.google.gwt.user.client.ui.Widget widget,
                   boolean canClose)

Parameters:

tabId -

icon -

tabText -

widget -

canClose -

addTabClosedHandler

public com.google.gwt.event.shared.HandlerRegistration addTabClosedHandler(TabClosedHandler tabClosedHandler)

Specified by:

addTabClosedHandler in interface HasTabClosedHandler

See Also:

HasTabClosedHandler.addTabClosedHandler(org.exoplatform.gwtframework.ui.client.tab.event.TabClosedHandler)

getSelectedTabID

public java.lang.String getSelectedTabID()

Gets the ID of selected tab.

Returns:

getTabIdByIndex

public java.lang.String getTabIdByIndex(int tabIndex)

Gets tab's ID through its index.

Parameters:

tabIndex -

Returns:

onCloseTab

public void onCloseTab(CloseTabEvent event)

Specified by:

onCloseTab in interface CloseTabHandler

See Also:

CloseTabHandler.onCloseTab(org.exoplatform.gwtframework.ui.client.tab.event.CloseTabEvent)

remove

public boolean remove(int index)

Specified by:

remove in interface com.google.gwt.user.client.ui.IndexedPanel

Overrides:

remove in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.remove(int)

remove

public boolean remove(com.google.gwt.user.client.ui.Widget widget)

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

remove in class com.google.gwt.user.client.ui.TabPanel

See Also:

TabPanel.remove(com.google.gwt.user.client.ui.Widget)

removeTabButton

public void removeTabButton(com.google.gwt.user.client.ui.Widget tabButton)

Removes user defined button from this TabPanel.

Parameters:

tabButton -

removeTab

public void removeTab(java.lang.String tabId)

Removes tab with specified Tab Id.

Parameters:

tabId -

scrollLeft

public void scrollLeft()

Scroll TabBar to the left.

Specified by:

scrollLeft in interface Scrollable

See Also:

Scrollable.scrollLeft()

scrollRight

public void scrollRight()

Scroll TabBar to the right.

Specified by:

scrollRight in interface Scrollable

See Also:

Scrollable.scrollRight()

selectTab

public void selectTab(java.lang.String tabId)

Selects tab with specified ID.

Parameters:

tabId - ID of tab which will be selected.

setTabHighlited

public void setTabHighlited(int tabIndex,
                            boolean isHighlited)

Parameters:

tabIndex -

isHighlited -

setTabIcon

public void setTabIcon(java.lang.String tabId,
                       com.google.gwt.user.client.ui.Image icon)

Parameters:

tabId -

icon -

setTabTitle

public void setTabTitle(java.lang.String tabId,
                        java.lang.String title)

Parameters:

tabId -

title -

onResize

public void onResize()

Specified by:

onResize in interface com.google.gwt.user.client.ui.RequiresResize

See Also:

RequiresResize.onResize()