com.vaadin.client.ui
Class VTabsheetBase

java.lang.Object
  ComplexPanel
      com.vaadin.client.ui.VTabsheetBase

Direct Known Subclasses:

VAccordion, VTabsheet

public abstract class VTabsheetBase
extends ComplexPanel

Field Summary

protected int	activeTabIndex For internal use only.
protected ApplicationConnection	client For internal use only.
protected AbstractComponentConnector	connector For internal use only.
protected boolean	disabled For internal use only.
protected java.util.Set<java.lang.String>	disabledTabKeys For internal use only.
protected boolean	readonly For internal use only.
protected java.util.ArrayList<java.lang.String>	tabKeys For internal use only.

Constructor Summary

VTabsheetBase(java.lang.String classname)

Method Summary

void	addTabKey(java.lang.String key, boolean disabled) For internal use only.
protected abstract void	clearPaintables() Clears current tabs and contents
void	clearTabKeys() For internal use only.
protected ComponentConnector	getConnectorForWidget(Widget widget) For internal use only.
abstract ComponentConnector	getTab(int index) Implement in extending classes.
abstract int	getTabCount() Implement in extending classes.
abstract java.util.Iterator<Widget>	getWidgetIterator()
protected boolean	isDynamicHeight() Returns true if the height of the widget is undefined, false otherwise.
protected boolean	isDynamicWidth() Returns true if the width of the widget is undefined, false otherwise.
boolean	isEnabled()
boolean	isTabCaptionsAsHtml() Checks whether captions are rendered as HTML The default is false, i.e.
abstract void	removeTab(int index) Implement in extending classes.
abstract void	renderTab(com.vaadin.shared.ui.tabsheet.TabState tabState, int index) Implement in extending classes.
abstract void	selectTab(int index) For internal use only.
void	setActiveTabIndex(int activeTabIndex) For internal use only.
void	setClient(ApplicationConnection client) For internal use only.
void	setConnector(AbstractComponentConnector connector) Sets the connector that should be notified of events etc.
void	setEnabled(boolean enabled) For internal use only.
void	setReadonly(boolean readonly) For internal use only.
void	setTabCaptionsAsHtml(boolean tabCaptionsAsHtml) Sets whether the caption is rendered as HTML.

Methods inherited from class java.lang.Object

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

Field Detail

client

protected ApplicationConnection client

For internal use only. May be removed or replaced in the future.

tabKeys

protected final java.util.ArrayList<java.lang.String> tabKeys

For internal use only. May be removed or replaced in the future.

disabledTabKeys

protected java.util.Set<java.lang.String> disabledTabKeys

For internal use only. May be removed or replaced in the future.

activeTabIndex

protected int activeTabIndex

For internal use only. May be removed or replaced in the future.

disabled

protected boolean disabled

For internal use only. May be removed or replaced in the future.

readonly

protected boolean readonly

For internal use only. May be removed or replaced in the future.

connector

protected AbstractComponentConnector connector

For internal use only. May be removed or replaced in the future.

Constructor Detail

VTabsheetBase

public VTabsheetBase(java.lang.String classname)

Method Detail

getWidgetIterator

public abstract java.util.Iterator<Widget> getWidgetIterator()

Returns:

a list of currently shown Widgets

clearPaintables

protected abstract void clearPaintables()

Clears current tabs and contents

renderTab

public abstract void renderTab(com.vaadin.shared.ui.tabsheet.TabState tabState,
                               int index)

Implement in extending classes. This method should render needed elements and set the visibility of the tab according to the 'selected' parameter.

getTabCount

public abstract int getTabCount()

Implement in extending classes. This method should return the number of tabs currently rendered.

getTab

public abstract ComponentConnector getTab(int index)

Implement in extending classes. This method should return the Paintable corresponding to the given index.

removeTab

public abstract void removeTab(int index)

Implement in extending classes. This method should remove the rendered tab with the specified index.

isDynamicWidth

protected boolean isDynamicWidth()

Returns true if the width of the widget is undefined, false otherwise.

Returns:

true if width of the widget is determined by its content

Since:

7.2

isDynamicHeight

protected boolean isDynamicHeight()

Returns true if the height of the widget is undefined, false otherwise.

Returns:

true if width of the height is determined by its content

Since:

7.2

setConnector

public void setConnector(AbstractComponentConnector connector)

Sets the connector that should be notified of events etc. For internal use only. This method may be removed or replaced in the future.

Parameters:

connector -

Since:

7.2

clearTabKeys

public void clearTabKeys()

For internal use only. May be removed or replaced in the future.

addTabKey

public void addTabKey(java.lang.String key,
                      boolean disabled)

For internal use only. May be removed or replaced in the future.

setClient

public void setClient(ApplicationConnection client)

For internal use only. May be removed or replaced in the future.

setActiveTabIndex

public void setActiveTabIndex(int activeTabIndex)

For internal use only. May be removed or replaced in the future.

setEnabled

public void setEnabled(boolean enabled)

For internal use only. May be removed or replaced in the future.

setReadonly

public void setReadonly(boolean readonly)

For internal use only. May be removed or replaced in the future.

getConnectorForWidget

protected ComponentConnector getConnectorForWidget(Widget widget)

For internal use only. May be removed or replaced in the future.

selectTab

public abstract void selectTab(int index)

For internal use only. May be removed or replaced in the future.

isEnabled

public boolean isEnabled()

setTabCaptionsAsHtml

public void setTabCaptionsAsHtml(boolean tabCaptionsAsHtml)

Sets whether the caption is rendered as HTML.

The default is false, i.e. render tab captions as plain text

Parameters:

captionAsHtml - true if the captions are rendered as HTML, false if rendered as plain text

Since:

7.4

isTabCaptionsAsHtml

public boolean isTabCaptionsAsHtml()

Checks whether captions are rendered as HTML The default is false, i.e. render tab captions as plain text

Returns:

true if the captions are rendered as HTML, false if rendered as plain text

Since:

7.4