com.whitestein.lsps.vaadin.forms

Class WTabSheet

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WComponentGroup

com.whitestein.lsps.vaadin.forms.WTabSheet

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

Direct Known Subclasses:

WAccordion

public class WTabSheet
extends WComponentGroup

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WTabSheet.WTab A tab.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.ui.TabSheet.CloseHandler	closeHandler

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WTabSheet()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractComponentContainer	createWidget() Called once, to create the actual Vaadin component.
String	getCustomErrorMessage(RecordHolder tab)
String	getDescription(RecordHolder tab) Gets the tab's description
RecordHolder	getSelectedTab() Returns currently selected forms::Tab
String	getStyleName(RecordHolder tab) Gets the style name of the tab
RecordHolder	getTabByComponent(RecordHolder child) Gets a tab containing the given content.
RecordHolder	getTabByIndex(Decimal tabIndex) Gets a tab at the given index.
String	getTabCaption(RecordHolder tab) Gets the caption of the tab.
ClosureHolder	getTabChangedListener() Gets the current tab change listener
RecordHolder	getTabContents(RecordHolder tab) Gets the content of the given tab.
Decimal	getTabIndex(RecordHolder tab)
ListHolder	getTabs() Gets a list of tabs in this tab sheet.
com.vaadin.ui.TabSheet	getWidget() Gets the Vaadin representation of this component.
boolean	isClosable(RecordHolder tab) Deprecated.
boolean	isEnabled(RecordHolder tab) Indicates whether a tab is enabled.
boolean	isVisible(RecordHolder tab) Indicates whether the tab is visible or not.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	removeAllComponents() Removes all components from this component group.
void	removeComponent(RecordHolder child) Removes the child component from this component group.
void	removeTab(RecordHolder tab) Removes tab from tab sheet.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setClosable(RecordHolder tab, boolean closable) Deprecated.
void	setCustomErrorMessage(RecordHolder tab, String description) Set error message to the tab.
void	setDescription(RecordHolder tab, String description) Sets the tab's description
void	setEnabled(RecordHolder tab, boolean enabled) Sets the enabled flag to a tab.
void	setIcon(RecordHolder tab, RecordHolder resource) Sets the tab's icon
void	setSelectedTab(RecordHolder tab) Selects a tab.
void	setSelectedTabByIndex(Decimal tabIndex) Selects a tab.
void	setStyleName(RecordHolder tab, String styleName) Sets a style name to a tab.
void	setTabCaption(RecordHolder tab, String caption) Sets a caption to the tab.
void	setTabChangedListener(ClosureHolder tabChangedListener) Sets a tab change listener.
void	setVisible(RecordHolder tab, boolean visible) Sets visibility to a tab.
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.WComponentGroup

addComponent, addComponentInt, getChildren, getComponentAt, getComponentCount, getComponents, getExpandRatio, getHasChildrenAdapter, isMargin, isSpacing, restoreChildComponents, setExpandRatio, setMargin, setSpacing, writeChildComponents

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

closeHandler

protected final com.vaadin.ui.TabSheet.CloseHandler closeHandler

Constructor Detail

WTabSheet

public WTabSheet()

Method Detail

getWidget

public com.vaadin.ui.TabSheet getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WComponentGroup

Returns:

the Vaadin representation of this form component.

createWidget

protected com.vaadin.ui.AbstractComponentContainer createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WComponentGroup

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

removeComponent

public void removeComponent(RecordHolder child)

Description copied from class: WComponentGroup

Removes the child component from this component group.

Overrides:

removeComponent in class WComponentGroup

Parameters:

child - the component to remove

removeTab

public void removeTab(RecordHolder tab)

Removes tab from tab sheet.

Parameters:

tab -

removeAllComponents

public void removeAllComponents()

Description copied from class: WComponentGroup

Removes all components from this component group.

Overrides:

removeAllComponents in class WComponentGroup

getTabByComponent

public RecordHolder getTabByComponent(RecordHolder child)

Gets a tab containing the given content.

Parameters:

child - the content of the tab

Returns:

the tab record

getTabByIndex

public RecordHolder getTabByIndex(Decimal tabIndex)

Gets a tab at the given index.

Parameters:

tabIndex -

Returns:

a tab record

getTabCaption

public String getTabCaption(RecordHolder tab)

Gets the caption of the tab.

Parameters:

tab -

Returns:

the tab caption

setTabCaption

public void setTabCaption(RecordHolder tab,
                          String caption)

Sets a caption to the tab.

Parameters:

tab -

caption -

setTabChangedListener

public void setTabChangedListener(ClosureHolder tabChangedListener)

Sets a tab change listener.

Parameters:

tabChangedListener -

getTabChangedListener

public ClosureHolder getTabChangedListener()

Gets the current tab change listener

Returns:

the closure handling the tab change event or null if no closure is set

getSelectedTab

public RecordHolder getSelectedTab()

Returns currently selected forms::Tab

Returns:

currently selected forms::Tab, may be null if the tab sheet is empty.

setSelectedTab

public void setSelectedTab(RecordHolder tab)

Selects a tab.

Parameters:

tab - the tab to select

setSelectedTabByIndex

public void setSelectedTabByIndex(Decimal tabIndex)

Selects a tab.

Parameters:

tabIndex - of the tab to select

getTabContents

public RecordHolder getTabContents(RecordHolder tab)

Gets the content of the given tab.

Parameters:

tab -

Returns:

the tab's content

getTabs

public ListHolder getTabs()

Gets a list of tabs in this tab sheet.

Returns:

a list of tabs

getTabIndex

public Decimal getTabIndex(RecordHolder tab)

Parameters:

tab -

Returns:

index of tab that represented by record holder.

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

isVisible

public boolean isVisible(RecordHolder tab)

Indicates whether the tab is visible or not.

Parameters:

tab -

Returns:

true if the tab is visible

setVisible

public void setVisible(RecordHolder tab,
                       boolean visible)

Sets visibility to a tab.

Parameters:

tab - the tab

visible -

isEnabled

public boolean isEnabled(RecordHolder tab)

Indicates whether a tab is enabled.

Parameters:

tab -

Returns:

true if the tab is enabled

setEnabled

public void setEnabled(RecordHolder tab,
                       boolean enabled)

Sets the enabled flag to a tab.

Parameters:

tab -

enabled -

isClosable

@Deprecated
public boolean isClosable(RecordHolder tab)

Deprecated.

Indicates whether a tab is closable.

Parameters:

tab -

Returns:

true if the tab is closable

setClosable

@Deprecated
public void setClosable(RecordHolder tab,
                                    boolean closable)

Deprecated.

Sets the closable value.

Parameters:

tab -

closable -

getStyleName

public String getStyleName(RecordHolder tab)

Gets the style name of the tab

Parameters:

tab -

Returns:

the tab's style name

setStyleName

public void setStyleName(RecordHolder tab,
                         String styleName)

Sets a style name to a tab.

Parameters:

tab - the tab

styleName - the style name to set to the tab

setIcon

public void setIcon(RecordHolder tab,
                    RecordHolder resource)

Sets the tab's icon

Parameters:

tab -

resource - a resource representing the icon

getDescription

public String getDescription(RecordHolder tab)

Gets the tab's description

Parameters:

tab -

Returns:

the description of the tab

setDescription

public void setDescription(RecordHolder tab,
                           String description)

Sets the tab's description

Parameters:

tab -

description - the description to set

getCustomErrorMessage

public String getCustomErrorMessage(RecordHolder tab)

Parameters:

tab -

Returns:

tabs error message or null

setCustomErrorMessage

public void setCustomErrorMessage(RecordHolder tab,
                                  String description)

Set error message to the tab.

Parameters:

tab -

description -

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class WComponentGroup

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class WComponentGroup

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)