org.opencms.gwt.client.ui

类 CmsTabbedPanel<E extends com.google.gwt.user.client.ui.Widget>

java.lang.Object

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

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

com.google.gwt.user.client.ui.Composite

org.opencms.gwt.client.ui.CmsTabbedPanel<E>

类型参数:

E - the tab widget type

所有已实现的接口:

com.alkacon.geranium.client.I_DescendantResizeHandler, 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.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget, java.lang.Iterable<E>

public class CmsTabbedPanel<E extends com.google.gwt.user.client.ui.Widget>
extends com.google.gwt.user.client.ui.Composite
implements com.alkacon.geranium.client.I_DescendantResizeHandler, java.lang.Iterable<E>

Wrapper class for @see com.google.user.client.ui.TabLayoutPanel.

Layout class for a panel with several tabs. The tabbed panel should be set inside a widget with given width and height. For table based layouts the height of the parent cell should be set explicitly. As layout options two height for the tabbar are provided: 32px("standard") and 25px("small").

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	CmsTabbedPanel.CmsTabbedPanelStyle Enumeration with layout keys.
protected class	CmsTabbedPanel.TabPanel Extending the TabLayoutPanel class to allow height adjustments to the tab bar.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

字段概要

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsTabbedPanel() The default constructor for an empty tabbed panel.
CmsTabbedPanel(CmsTabbedPanel.CmsTabbedPanelStyle tabbedPanelStyle) The constructor for an empty tabbed panel.

方法概要

方法

限定符和类型	方法和说明
void	add(E tabContent, java.lang.String tabName) Add a new tab with the provided name and content.
com.google.gwt.event.shared.HandlerRegistration	addBeforeSelectionHandler(com.google.gwt.event.logical.shared.BeforeSelectionHandler<java.lang.Integer> handler) Add the before selection handler to the tabbed panel.
void	addNamed(E tabContent, java.lang.String tabName, java.lang.String tabId) Adds a tab with a user-defined id.
com.google.gwt.event.shared.HandlerRegistration	addSelectionHandler(com.google.gwt.event.logical.shared.SelectionHandler<java.lang.Integer> handler) Adds a SelectionEvent handler to the tabbed panel.
void	addWithLeftMargin(E tabContent, java.lang.String tabName) Add a new tab with the provided name and content and additional left margin.
void	disableTab(E tabContent, java.lang.String reason) Disables the tab with the given index.
void	enableTab(E tabContent) Enables the tab with the given index.
int	getSelectedIndex() Gets the index of the currently-selected tab.
E	getTabById(java.lang.String tabId) Finds a tab with a given id.
int	getTabCount() Gets the number of child widgets in this panel.
protected com.google.gwt.user.client.ui.TabLayoutPanel	getTabPanel() Returns the tab layout panel.
java.lang.String	getTabText(int pos) Returns the tab text for a given tab.
E	getWidget(int tabIndex) Gets the child widget at the specified index.
void	insert(E tabContent, java.lang.String tabName, int beforeIndex) Inserts a widget into the panel.
boolean	isDisabledTab(int tabIndex) Returns true if the tab with the given index is disabled, false otherwise.
java.util.Iterator<E>	iterator() Returns an iterator over all tabs.
protected void	onLoad()
void	onResizeDescendant()
void	removeTab(int tabIndex) Removes the tab with the given index.
void	selectTab(E tabWidget) Delegate method.
void	selectTab(E tabWidget, boolean fireEvent) Delegate method.
void	selectTab(int tabIndex) Delegate method.
void	selectTab(int tabIndex, boolean fireEvent) Delegate method.
void	setAutoResize(boolean autoResize) Enables or disables auto-resizing.
void	setAutoResizeHeightDelta(int heightDelta) Sets a value which is added to the height of a tab content to change the tabbed panel height.
protected void	setOverflowVisibleToContent() Sets the overflow of the tab layout content's parent to visible.
void	setTabText(int pos, java.lang.String text) Sets the text of a given tab.

从类继承的方法 com.google.gwt.user.client.ui.Composite

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

从类继承的方法 com.google.gwt.user.client.ui.Widget

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

从类继承的方法 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, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

从类继承的方法 java.lang.Object

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

构造器详细资料

CmsTabbedPanel

public CmsTabbedPanel()

The default constructor for an empty tabbed panel.

CmsTabbedPanel

public CmsTabbedPanel(CmsTabbedPanel.CmsTabbedPanelStyle tabbedPanelStyle)

The constructor for an empty tabbed panel.

参数:

tabbedPanelStyle - the pre-defined height of the tabbar, can be "small" or "standard"

方法详细资料

add

public void add(E tabContent,
       java.lang.String tabName)

Add a new tab with the provided name and content.

Wrapper function for TabLayoutPanel.add(Widget, String)

参数:

tabContent - the widget to add as a tab

tabName - the name of the tab to display in the tabbar

addBeforeSelectionHandler

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

Add the before selection handler to the tabbed panel.

Wrapper function for TabLayoutPanel.addBeforeSelectionHandler(BeforeSelectionHandler)

参数:

handler - the before selection handler

返回:

the registration for the event

addNamed

public void addNamed(E tabContent,
            java.lang.String tabName,
            java.lang.String tabId)

Adds a tab with a user-defined id.

参数:

tabContent -

tabName -

tabId -

addSelectionHandler

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

Adds a SelectionEvent handler to the tabbed panel.

Wrapper function for TabLayoutPanel.addSelectionHandler(SelectionHandler)

参数:

handler - the selection handler

返回:

the registration for the event

addWithLeftMargin

public void addWithLeftMargin(E tabContent,
                     java.lang.String tabName)

Add a new tab with the provided name and content and additional left margin.

参数:

tabContent - the widget to add as a tab

tabName - the name of the tab to display in the tabbar

disableTab

public void disableTab(E tabContent,
              java.lang.String reason)

Disables the tab with the given index.

参数:

tabContent - the content of the tab that should be disabled

reason - the reason why the tab is disabled

enableTab

public void enableTab(E tabContent)

Enables the tab with the given index.

参数:

tabContent - the content of the tab that should be enabled

getSelectedIndex

public int getSelectedIndex()

Gets the index of the currently-selected tab.

Wrapper function for TabLayoutPanel.getSelectedIndex()

返回:

the selected index, or -1 if none is selected.

getTabById

public E getTabById(java.lang.String tabId)

Finds a tab with a given id.

参数:

tabId - a tab id

返回:

the tab with the given id

getTabCount

public int getTabCount()

Gets the number of child widgets in this panel.

Wrapper function for TabLayoutPanel.getWidgetCount()

返回:

the number of children

getTabText

public java.lang.String getTabText(int pos)

Returns the tab text for a given tab.

参数:

pos - the index of the tab

返回:

the text of the tab

getWidget

public E getWidget(int tabIndex)

Gets the child widget at the specified index.

Wrapper function for TabLayoutPanel.getWidget(int)

参数:

tabIndex - the child widget's index

返回:

the child widget

insert

public void insert(E tabContent,
          java.lang.String tabName,
          int beforeIndex)

Inserts a widget into the panel. If the Widget is already attached, it will be moved to the requested index.

Wrapper function for TabLayoutPanel.insert(Widget, String, int)

参数:

tabContent - the widget to be added

tabName - the text to be shown on its tab

beforeIndex - the index before which it will be inserted

isDisabledTab

public boolean isDisabledTab(int tabIndex)

Returns true if the tab with the given index is disabled, false otherwise.

参数:

tabIndex - the tab index

返回:

true if the tab with the given index is disabled, false otherwise

iterator

public java.util.Iterator<E> iterator()

Returns an iterator over all tabs.

指定者:

iterator 在接口中 java.lang.Iterable<E extends com.google.gwt.user.client.ui.Widget>

返回:

the iterator

onResizeDescendant

public void onResizeDescendant()

指定者:

onResizeDescendant 在接口中 com.alkacon.geranium.client.I_DescendantResizeHandler

另请参阅:

I_DescendantResizeHandler.onResizeDescendant()

removeTab

public void removeTab(int tabIndex)

Removes the tab with the given index.

参数:

tabIndex - the index of the tab which should be removed

selectTab

public void selectTab(E tabWidget)

Delegate method.

参数:

tabWidget - the tab widget to select

另请参阅:

TabLayoutPanel.selectTab(Widget index)

selectTab

public void selectTab(E tabWidget,
             boolean fireEvent)

Delegate method.

参数:

tabWidget - the tab widget to select

fireEvent - true to fire the tab event

另请参阅:

TabLayoutPanel.selectTab(Widget index)

selectTab

public void selectTab(int tabIndex)

Delegate method.

参数:

tabIndex - the index of the tab to be selected

另请参阅:

TabLayoutPanel.selectTab(int index)

selectTab

public void selectTab(int tabIndex,
             boolean fireEvent)

Delegate method.

参数:

tabIndex - the index of the tab to be selected

fireEvent - true to fire the tab event

另请参阅:

TabLayoutPanel.selectTab(int index)

setAutoResize

public void setAutoResize(boolean autoResize)

Enables or disables auto-resizing.

参数:

autoResize - the auto resize flag value

setAutoResizeHeightDelta

public void setAutoResizeHeightDelta(int heightDelta)

Sets a value which is added to the height of a tab content to change the tabbed panel height.

参数:

heightDelta - the height difference

setTabText

public void setTabText(int pos,
              java.lang.String text)

Sets the text of a given tab.

参数:

pos - the index of the tab

text - the new text for the tab

getTabPanel

protected com.google.gwt.user.client.ui.TabLayoutPanel getTabPanel()

Returns the tab layout panel.

返回:

the tab layout panel

onLoad

protected void onLoad()

覆盖:

onLoad 在类中 com.google.gwt.user.client.ui.Widget

另请参阅:

Widget.onLoad()

setOverflowVisibleToContent

protected void setOverflowVisibleToContent()

Sets the overflow of the tab layout content's parent to visible.