com.vaadin.terminal.gwt.client.ui
Class VTabsheet

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.ComplexPanel
                  com.vaadin.terminal.gwt.client.ui.VTabsheet

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.IndexedPanel, Container, Paintable, Iterable<com.google.gwt.user.client.ui.Widget>

public class VTabsheet
extends com.google.gwt.user.client.ui.ComplexPanel

Nested Class Summary

class

VTabsheet.PlaceHolder

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

protected int	activeTabIndex
protected boolean	cachedUpdate
static String	CLASSNAME
protected boolean	disabled
protected Set	disabledTabKeys
protected boolean	readonly
static String	SCROLLER_CLASSNAME
protected ArrayList	tabKeys
static String	TABS_CLASSNAME

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

DEBUG_ID_PREFIX

Constructor Summary

VTabsheet()

Method Summary

protected void	clearPaintables() Clears current tabs and contents
RenderSpace	getAllocatedSpace(com.google.gwt.user.client.ui.Widget child) Returns the size currently allocated for the child component.
protected Iterator	getPaintableIterator()
protected Paintable	getTab(int index) Implement in extending classes.
protected int	getTabCount() Implement in extending classes.
boolean	hasChildComponent(com.google.gwt.user.client.ui.Widget component) Is a given component child of this layout.
void	iLayout()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	removeTab(int index) Implement in extending classes.
protected void	renderTab(UIDL tabUidl, int index, boolean selected, boolean hidden) Implement in extending classes.
void	replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent, com.google.gwt.user.client.ui.Widget newComponent) Replace child of this layout with another component.
boolean	requestLayout(Set<Paintable> child) Called when a child components size has been updated in the rendering phase.
protected void	selectTab(int index, UIDL contentUidl) Implement in extending classes.
void	setHeight(String height)
void	setWidth(String width)
void	updateCaption(Paintable component, UIDL uidl) Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, insert, insert, iterator, remove, remove

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, onLoad, onUnload, orphan

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

addDomHandler, addHandler, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, 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, setElement, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

TABS_CLASSNAME

public static final String TABS_CLASSNAME

See Also:

Constant Field Values

SCROLLER_CLASSNAME

public static final String SCROLLER_CLASSNAME

See Also:

Constant Field Values

tabKeys

protected final ArrayList tabKeys

activeTabIndex

protected int activeTabIndex

disabled

protected boolean disabled

readonly

protected boolean readonly

disabledTabKeys

protected Set disabledTabKeys

cachedUpdate

protected boolean cachedUpdate

Constructor Detail

VTabsheet

public VTabsheet()

Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

renderTab

protected void renderTab(UIDL tabUidl,
                         int index,
                         boolean selected,
                         boolean hidden)

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

selectTab

protected void selectTab(int index,
                         UIDL contentUidl)

Implement in extending classes. This method should render any previously non-cached content and set the activeTabIndex property to the specified index.

setHeight

public void setHeight(String height)

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

setWidth

public void setWidth(String width)

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

iLayout

public void iLayout()

clearPaintables

protected void clearPaintables()

Clears current tabs and contents

getPaintableIterator

protected Iterator getPaintableIterator()

Returns:

a list of currently shown Paintables

hasChildComponent

public boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)

Description copied from interface: Container

Is a given component child of this layout.

Parameters:

component - Component to test.

Returns:

true iff component is a child of this layout.

replaceChildComponent

public void replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent,
                                  com.google.gwt.user.client.ui.Widget newComponent)

Description copied from interface: Container

Replace child of this layout with another component. Each layout must be able to switch children. To to this, one must just give references to a current and new child.

Parameters:

oldComponent - Child to be replaced

newComponent - Child that replaces the oldComponent

updateCaption

public void updateCaption(Paintable component,
                          UIDL uidl)

Description copied from interface: Container

Update child components caption, description and error message.

Each component is responsible for maintaining its caption, description and error message. In most cases components doesn't want to do that and those elements reside outside of the component. Because of this layouts must provide service for it's childen to show those elements for them.

Parameters:

component - Child component for which service is requested.

uidl - UIDL of the child component.

requestLayout

public boolean requestLayout(Set<Paintable> child)

Description copied from interface: Container

Called when a child components size has been updated in the rendering phase.

Parameters:

child - Set of child widgets whose size have changed

Returns:

true if the size of the Container remains the same, false if the event need to be propagated to the Containers parent

getAllocatedSpace

public RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)

Description copied from interface: Container

Returns the size currently allocated for the child component.

Returns:

getTabCount

protected int getTabCount()

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

getTab

protected Paintable getTab(int index)

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

removeTab

protected void removeTab(int index)

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