com.whitestein.lsps.vaadin.forms

Class WTree

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.ComponentWithValue<T>

com.whitestein.lsps.vaadin.forms.WInputComponentWithValue<Object>

com.whitestein.lsps.vaadin.forms.WTree

All Implemented Interfaces:

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

public class WTree
extends WInputComponentWithValue<Object>

Allows selection of a single item from a list which is formatted as a tree.

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

ComponentWithValue.ValueChangeListenerImpl, ComponentWithValue.ValueProperty<T>

Field Summary

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

refreshing

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
WTree() Creates a new instnace of this class.

Method Summary

Modifier and Type	Method and Description
protected ValueProvider	createCaptionValueProvider(RecordHolder captionValueProvider)
protected ITreeDataSource	createDataSource(RecordHolder dataSource)
protected com.vaadin.ui.AbstractSelect	createWidget() Called once, to create the actual Vaadin component.
protected Integer	findId(Variant<Object> value)
protected com.vaadin.server.Resource	getIcon(Object rowObject) Override to provide icon for items.
com.vaadin.ui.Tree	getWidget() Gets the Vaadin representation of this component.
protected Integer	loadUpTo(Variant<Object> upToValue)
protected void	onPropertyValueSet(Object newValue) This method is called each time components property value is set.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	refresh() Refreshes the component (binding, datasource, children).
void	refreshBinding() Refreshes the content of this component using the provided binding.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setExpand(ClosureHolder expand) Sets the expand predicate closure.
void	setOptions(RecordHolder dataSource, RecordHolder captionValueProvider) Creates a data source via createDataSource(RecordHolder), clears the tree and re-populates its roots.
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.WInputComponentWithValue

addValidator, fireValueChanged, focus, getOnChange, getValidationErrors, inferValidator, isConvertible, isImmediate, isRequired, isValid, removeAllValidators, setImmediate, setOnChange, setRequired

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

getBinding, getProperty, isFullyInitialized, setProperty

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

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, 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

Constructor Detail

WTree

public WTree()

Creates a new instnace of this class.

Method Detail

createWidget

protected com.vaadin.ui.AbstractSelect createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WInputComponentWithValue<Object>

Returns:

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

getWidget

public com.vaadin.ui.Tree getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WInputComponentWithValue<Object>

Returns:

the Vaadin representation of this form component.

getIcon

protected com.vaadin.server.Resource getIcon(Object rowObject)

Override to provide icon for items.

Parameters:

rowObject - the row object

Returns:

the icon or null if there is no icon for the item. Default implementation always returns null.

createDataSource

protected ITreeDataSource createDataSource(RecordHolder dataSource)

createCaptionValueProvider

protected ValueProvider createCaptionValueProvider(RecordHolder captionValueProvider)

setOptions

public void setOptions(RecordHolder dataSource,
                       RecordHolder captionValueProvider)

Creates a data source via createDataSource(RecordHolder), clears the tree and re-populates its roots.

Parameters:

dataSource - forms::DataSource instance

captionValueProvider - forms::ValueProvider instance, provides captions for row objects.

setExpand

public void setExpand(ClosureHolder expand)

Sets the expand predicate closure. The closure is expected to accept two parameters: items' data and item's depth.

Parameters:

expand - the expand predicate

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 WInputComponentWithValue<Object>

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.

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 WInputComponentWithValue<Object>

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 WInputComponentWithValue<Object>

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

refresh

public void refresh()

Description copied from class: ComponentWithValue

Refreshes the component (binding, datasource, children).

Overrides:

refresh in class ComponentWithValue<Object>

refreshBinding

public void refreshBinding()

Description copied from class: ComponentWithValue

Refreshes the content of this component using the provided binding.

Overrides:

refreshBinding in class ComponentWithValue<Object>

onPropertyValueSet

protected void onPropertyValueSet(Object newValue)

Description copied from class: ComponentWithValue

This method is called each time components property value is set. User for example by WTree.

Overrides:

onPropertyValueSet in class ComponentWithValue<Object>

findId

protected Integer findId(Variant<Object> value)

loadUpTo

protected Integer loadUpTo(Variant<Object> upToValue)