com.itmill.toolkit.ui
Class TabSheet

java.lang.Object
  extended by com.itmill.toolkit.ui.AbstractComponent
      extended by com.itmill.toolkit.ui.AbstractComponentContainer
          extended by com.itmill.toolkit.ui.TabSheet
All Implemented Interfaces:
MethodEventSource, Paintable, Paintable.RepaintRequestListener, Sizeable, VariableOwner, Component, ComponentContainer, EventListener
Direct Known Subclasses:
Accordion

public class TabSheet
extends AbstractComponentContainer
implements Paintable.RepaintRequestListener

Tabsheet component.

Since:
3.0
Version:
5.3.0
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 class com.itmill.toolkit.ui.AbstractComponent
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler
 
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
 
Field Summary
 
Fields inherited from interface com.itmill.toolkit.terminal.Sizeable
SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
 
Constructor Summary
TabSheet()
          Constructs a new Tabsheet.
 
Method Summary
 void addComponent(Component c)
          Adds a new tab into TabSheet.
 void addListener(TabSheet.SelectedTabChangeListener listener)
          Adds the selected tab change listener
 void addTab(Component c)
          Adds a new tab into TabSheet.
 void addTab(Component c, String caption, Resource icon)
          Adds a new tab into TabSheet.
 boolean areTabsHidden()
          Are tabs hidden.
 void changeVariables(Object source, Map variables)
          Invoked when the value of a variable has changed.
 void detach()
          Notifies all contained components that the container is detached from a window.
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 repaintRequested(Paintable.RepaintRequestEvent event)
          Receives repaint request events.
 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 tabs captions.
 void setTabIcon(Component c, Resource icon)
          Sets overridden icon for given component.
 
Methods inherited from class com.itmill.toolkit.ui.AbstractComponentContainer
addListener, addListener, attach, fireComponentAttachEvent, fireComponentDetachEvent, removeAllComponents, removeListener, removeListener, requestRepaintAll, setEnabled, setHeight, setWidth
 
Methods inherited from class com.itmill.toolkit.ui.AbstractComponent
addListener, addListener, addListener, addListener, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setWidth, setWidth, setWidthUnits, setVisible
 
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, addStyleName, childRequestedRepaint, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setIcon, setParent, setReadOnly, setStyleName, setVisible
 
Methods inherited from interface com.itmill.toolkit.terminal.Paintable
addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId
 
Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner
isImmediate
 
Methods inherited from interface com.itmill.toolkit.terminal.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUnits
 

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.

Specified by:
getComponentIterator in interface ComponentContainer
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 a new tab into TabSheet. Components caption and icon are rendered into tab.

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 a new tab into TabSheet.

Parameters:
c - the component to be added onto tab.
caption - the caption to be set for the component and used rendered in tab bar
icon - the icon to be set for the component and used rendered in tab bar

addTab

public void addTab(Component c)
Adds a new tab into TabSheet. Components caption and icon are rendered into tab.

Parameters:
c - the component to be added onto 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 tabs captions.

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 overridden icon for given component. Normally TabSheet uses icon from 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.

Specified by:
replaceComponent in interface ComponentContainer
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.


repaintRequested

public void repaintRequested(Paintable.RepaintRequestEvent event)
Description copied from interface: Paintable.RepaintRequestListener
Receives repaint request events.

Specified by:
repaintRequested in interface Paintable.RepaintRequestListener
Parameters:
event - the repaint request event specifying the paintable source.

detach

public void detach()
Description copied from class: AbstractComponentContainer
Notifies all contained components that the container is detached from a window.

Specified by:
detach in interface Component
Overrides:
detach in class AbstractComponentContainer
See Also:
Component.detach()


Copyright © 2000-2009 IT Mill Ltd. All Rights Reserved.