org.gwt.advanced.client.ui.widget

Class AdvancedTabPanel

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

org.gwt.advanced.client.ui.widget.AdvancedTabPanel

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers<Integer>, com.google.gwt.event.logical.shared.HasSelectionHandlers<Integer>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, Resizable

public class AdvancedTabPanel
extends com.google.gwt.user.client.ui.SimplePanel
implements com.google.gwt.event.logical.shared.HasSelectionHandlers<Integer>, com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers<Integer>, Resizable

This is ana dvanced tab panel implementation that allows placing tabs around the content.

Since:

1.4.6

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AdvancedTabPanel.TabHolder The class implements a pair of widgets related to each other.
protected class	AdvancedTabPanel.TabState Describes the tab state (enabled or disabled.

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

Constructors

Constructor and Description
AdvancedTabPanel() Creates an instance of this class and displays top tabs band.
AdvancedTabPanel(TabPosition position) Creates an instance of this class and displays the tabs band in the specified position.
AdvancedTabPanel(TabPosition position, BorderFactory tabBorderFactory, BorderFactory contentBorderFactory) Creates an instance of this class and displays the panel using the specified border factories.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(com.google.gwt.user.client.ui.Widget content, com.google.gwt.user.client.ui.Widget tab) Do the same things like the addTab(com.google.gwt.user.client.ui.Widget, com.google.gwt.user.client.ui.Widget) method and included into the class for changing from GWT TabPanel to this one.
com.google.gwt.event.shared.HandlerRegistration	addBeforeSelectionHandler(com.google.gwt.event.logical.shared.BeforeSelectionHandler<Integer> beforeSelectionHandler)
com.google.gwt.event.shared.HandlerRegistration	addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<Integer> selectionHandler)
void	addTab(com.google.gwt.user.client.ui.Widget tab, com.google.gwt.user.client.ui.Widget content) Adds a new tab into the panel.
int	count() Gets a total count of tabs.
com.google.gwt.user.client.ui.Widget	getContent(com.google.gwt.user.client.ui.Widget tab) Gets the content widget by the tab.
Border	getContentBorder() Gets a content border that is already rendered.
BorderFactory	getContentBorderFactory() Gets the content border factory.
TabPosition	getPosition() Gets tabs position.
int	getSelected() Gets an index of the selected tab.
com.google.gwt.user.client.ui.Widget	getTab(int index) Gets the tab widget by index.
BorderFactory	getTabBorderFactory() Gets the tabs border factory.
int	indexOf(com.google.gwt.user.client.ui.Widget tab) Gets an index of the specified tab.
void	insertTab(com.google.gwt.user.client.ui.Widget tab, com.google.gwt.user.client.ui.Widget content, int before) Inserts the tab before the specified tab.
void	removeTab(com.google.gwt.user.client.ui.Widget tab) Removes the tab from the panel.
protected void	render() Renders the widget.
protected void	renderTabs() This method renders tabs band widget and puts it in the current position.
void	resize() This method does resizing of the widget.
void	selectTab(int index) Do the same things like the setSelected(int) method and included into the class for changing from GWT TabPanel to this one.
void	setSelected(int index) Sets the specified tab selected.
void	setSelected(com.google.gwt.user.client.ui.Widget tab) Sets the tab selected.
void	setTabEnabled(int tabIndex, boolean enable) Sets the specified tab enabled or disabled.

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

add, getContainerElement, getWidget, iterator, remove, setWidget, setWidget

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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, onAttach, onBrowserEvent, onDetach, 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, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, 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

AdvancedTabPanel

public AdvancedTabPanel()

Creates an instance of this class and displays top tabs band.

AdvancedTabPanel

public AdvancedTabPanel(TabPosition position)

Creates an instance of this class and displays the tabs band in the specified position.

Parameters:

position - is a tabs position.

AdvancedTabPanel

public AdvancedTabPanel(TabPosition position,
                BorderFactory tabBorderFactory,
                BorderFactory contentBorderFactory)

Creates an instance of this class and displays the panel using the specified border factories.

Parameters:

position - is a position of tabs.

tabBorderFactory - is a factory for tabs border.

contentBorderFactory - is a factory for the content border.

Method Detail

add

public void add(com.google.gwt.user.client.ui.Widget content,
       com.google.gwt.user.client.ui.Widget tab)

Do the same things like the addTab(com.google.gwt.user.client.ui.Widget, com.google.gwt.user.client.ui.Widget) method and included into the class for changing from GWT TabPanel to this one.

Parameters:

content - is a tab content.

tab - is a tab header.

selectTab

public void selectTab(int index)

Do the same things like the setSelected(int) method and included into the class for changing from GWT TabPanel to this one.

Parameters:

index - is a selected tab index.

addTab

public void addTab(com.google.gwt.user.client.ui.Widget tab,
          com.google.gwt.user.client.ui.Widget content)

Adds a new tab into the panel.

Parameters:

tab - is a tab widget.

content - is a content widget.

removeTab

public void removeTab(com.google.gwt.user.client.ui.Widget tab)

Removes the tab from the panel.

Parameters:

tab - is a tab widget to identify the tab.

insertTab

public void insertTab(com.google.gwt.user.client.ui.Widget tab,
             com.google.gwt.user.client.ui.Widget content,
             int before)

Inserts the tab before the specified tab.

Parameters:

tab - is a tab widget.

content - is a tab widget.

before - is an index of existent tab.

setSelected

public void setSelected(int index)

Sets the specified tab selected.

Parameters:

index - is an index of the tab for selection.

setSelected

public void setSelected(com.google.gwt.user.client.ui.Widget tab)

Sets the tab selected.

Parameters:

tab - is a widget of the tab to select.

getSelected

public int getSelected()

Gets an index of the selected tab.

Returns:

an index of the selected tab.

getTab

public com.google.gwt.user.client.ui.Widget getTab(int index)

Gets the tab widget by index.

Parameters:

index - is an index of the tab.

Returns:

a tab widget.

getContent

public com.google.gwt.user.client.ui.Widget getContent(com.google.gwt.user.client.ui.Widget tab)

Gets the content widget by the tab.

Parameters:

tab - is a tab widget.

Returns:

a content widget.

indexOf

public int indexOf(com.google.gwt.user.client.ui.Widget tab)

Gets an index of the specified tab.

If there is no such widget, returns -1.

Parameters:

tab - is a widget of the tab.

Returns:

an index of the tab.

count

public int count()

Gets a total count of tabs.

Returns:

a total count.

setTabEnabled

public void setTabEnabled(int tabIndex,
                 boolean enable)

Sets the specified tab enabled or disabled.

Parameters:

tabIndex - is a tab index.

enable - is a tab state value.

getTabBorderFactory

public BorderFactory getTabBorderFactory()

Gets the tabs border factory.

Returns:

is the tabs border factory that is currently used.

getContentBorderFactory

public BorderFactory getContentBorderFactory()

Gets the content border factory.

Returns:

is the content border factory that is currently used.

getContentBorder

public Border getContentBorder()

Gets a content border that is already rendered.

Returns:

a content border.

getPosition

public TabPosition getPosition()

Gets tabs position.

Returns:

tabs position.

render

protected void render()

Renders the widget.

renderTabs

protected void renderTabs()

This method renders tabs band widget and puts it in the current position.

resize

public void resize()

This method does resizing of the widget.

Specified by:

resize in interface Resizable

addSelectionHandler

public com.google.gwt.event.shared.HandlerRegistration addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<Integer> selectionHandler)

Specified by:

addSelectionHandler in interface com.google.gwt.event.logical.shared.HasSelectionHandlers<Integer>

addBeforeSelectionHandler

public com.google.gwt.event.shared.HandlerRegistration addBeforeSelectionHandler(com.google.gwt.event.logical.shared.BeforeSelectionHandler<Integer> beforeSelectionHandler)

Specified by:

addBeforeSelectionHandler in interface com.google.gwt.event.logical.shared.HasBeforeSelectionHandlers<Integer>