com.itmill.toolkit.ui
Class TabSheet

java.lang.Object
  com.itmill.toolkit.terminal.Identifiable
      com.itmill.toolkit.ui.AbstractComponent
          com.itmill.toolkit.ui.AbstractComponentContainer
              com.itmill.toolkit.ui.TabSheet

All Implemented Interfaces:

MethodEventSource, Paintable, VariableOwner, Component, ComponentContainer, EventListener

public class TabSheet
extends AbstractComponentContainer

Tabsheet component.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Nested Class Summary

class	TabSheet.SelectedTabChangeEvent Selected Tab Change event.
static interface	TabSheet.SelectedTabChangeListener Selected Tab Change Event listener

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Constructor Summary

TabSheet()
Constructs a new Tabsheet.

Method Summary

void	addComponent(Component c) Adds the component into this container.
void	addListener(TabSheet.SelectedTabChangeListener listener) Adds the selected tab change listener
void	addTab(Component c, String caption, Resource icon) Adds the new tab into TabSheet.
boolean	areTabsHidden() Are tabs hidden.
void	changeVariables(Object source, Map variables) Invoked when the value of a variable has changed.
protected void	fireSelectedTabChange() Emits the options change event.
Iterator	getComponentIterator() Gets the component container iterator for going trough all the components in the container.
Component	getSelectedTab() Gets the selected tab.
String	getTabCaption(Component c) Gets the caption for a component.
Resource	getTabIcon(Component c) Gets the icon for a component.
String	getTag() Gets the component UIDL tag.
void	hideTabs(boolean tabsHidden) Setter for property tabsHidden.
void	moveComponentsFrom(ComponentContainer source) Moves all components from another container to this container.
void	paintContent(PaintTarget target) Paints the content of this component.
void	removeComponent(Component c) Removes the component from this container.
void	removeListener(TabSheet.SelectedTabChangeListener listener) Removes the selected tab change listener
void	replaceComponent(Component oldComponent, Component newComponent) Replaces the component in the container with another one without changing position.
void	setSelectedTab(Component c) Sets the selected tab.
void	setTabCaption(Component c, String caption) Sets the caption for a component.
void	setTabIcon(Component c, Resource icon) ] Sets the icon for a component.

Methods inherited from class com.itmill.toolkit.ui.AbstractComponentContainer

addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, removeAllComponents, removeListener, removeListener

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent

addListener, addListener, addListener, addListener, childRequestedRepaint, dependsOn, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDescription, getDirectDependencies, getErrorMessage, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setReadOnly, setStyle, setVisible

Methods inherited from class com.itmill.toolkit.terminal.Identifiable

getDebugId, getUIID, setDebugId, setUIID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itmill.toolkit.ui.Component

addListener, childRequestedRepaint, getApplication, getCaption, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isReadOnly, isVisible, removeListener, setEnabled, setParent, setReadOnly, setStyle, setVisible

Methods inherited from interface com.itmill.toolkit.terminal.Paintable

addListener, paint, removeListener, requestRepaint, requestRepaintRequests

Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner

dependsOn, getDirectDependencies, isImmediate, removeDirectDependency

Constructor Detail

TabSheet

public TabSheet()

Constructs a new Tabsheet. Tabsheet is immediate by default.

Method Detail

getComponentIterator

public Iterator getComponentIterator()

Gets the component container iterator for going trough all the components in the container.

Returns:

the Iterator of the components inside the container.

removeComponent

public void removeComponent(Component c)

Removes the component from this container.

Specified by:

removeComponent in interface ComponentContainer

Overrides:

removeComponent in class AbstractComponentContainer

Parameters:

c - the component to be removed.

See Also:

ComponentContainer.removeComponent(Component)

addComponent

public void addComponent(Component c)

Adds the component into this container. The component is added as a tab where its default tab-caption is the caption of the component.

Specified by:

addComponent in interface ComponentContainer

Overrides:

addComponent in class AbstractComponentContainer

Parameters:

c - the component to be added.

See Also:

ComponentContainer.addComponent(Component)

addTab

public void addTab(Component c,
                   String caption,
                   Resource icon)

Adds the new tab into TabSheet.

Parameters:

c - the component to be added onto tab.

caption - the caption of the tab.

icon - the Set the icon of the tab.

getTag

public String getTag()

Gets the component UIDL tag.

Specified by:

getTag in class AbstractComponent

Returns:

the Component UIDL tag as string.

moveComponentsFrom

public void moveComponentsFrom(ComponentContainer source)

Moves all components from another container to this container. The components are removed from the other container.

Specified by:

moveComponentsFrom in interface ComponentContainer

Overrides:

moveComponentsFrom in class AbstractComponentContainer

Parameters:

source - the container components are removed from.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the content of this component.

Overrides:

paintContent in class AbstractComponent

Parameters:

event - the Paint Event.

Throws:

PaintException - if the paint operation failed.

areTabsHidden

public boolean areTabsHidden()

Are tabs hidden.

Returns:

the Property visibility.

hideTabs

public void hideTabs(boolean tabsHidden)

Setter for property tabsHidden.

Parameters:

tabsHidden - True if the tabs should be hidden.

getTabCaption

public String getTabCaption(Component c)

Gets the caption for a component.

Parameters:

c - the component.

setTabCaption

public void setTabCaption(Component c,
                          String caption)

Sets the caption for a component.

Parameters:

c - the component.

caption - the caption to set.

getTabIcon

public Resource getTabIcon(Component c)

Gets the icon for a component.

Parameters:

c - the component.

setTabIcon

public void setTabIcon(Component c,
                       Resource icon)

] Sets the icon for a component.

Parameters:

c -

icon -

setSelectedTab

public void setSelectedTab(Component c)

Sets the selected tab.

Parameters:

c -

getSelectedTab

public Component getSelectedTab()

Gets the selected tab.

Returns:

the selected tab.

changeVariables

public void changeVariables(Object source,
                            Map variables)

Invoked when the value of a variable has changed.

Specified by:

changeVariables in interface VariableOwner

Overrides:

changeVariables in class AbstractComponent

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.

See Also:

AbstractComponent.changeVariables(java.lang.Object, java.util.Map)

replaceComponent

public void replaceComponent(Component oldComponent,
                             Component newComponent)

Description copied from interface: ComponentContainer

Replaces the component in the container with another one without changing position.

This method replaces component with another one is such way that the new component overtakes the position of the old component. If the old component is not in the container, the new component is added to the container. If the both component are already in the container, their positions are swapped. Component attach and detach events should be taken care as with add and remove.

Parameters:

oldComponent - the old component that will be replaced.

newComponent - the new component to be replaced.

addListener

public void addListener(TabSheet.SelectedTabChangeListener listener)

Adds the selected tab change listener

Parameters:

listener - the Listener to be added.

removeListener

public void removeListener(TabSheet.SelectedTabChangeListener listener)

Removes the selected tab change listener

Parameters:

listener - the Listener to be removed.

fireSelectedTabChange

protected void fireSelectedTabChange()

Emits the options change event.