org.olat.core.gui.components.form.flexible.impl.elements
Class MultiSelectionTree

java.lang.Object
  org.olat.core.gui.components.form.flexible.impl.FormItemImpl
      org.olat.core.gui.components.form.flexible.impl.elements.MultipleSelectionElementImpl
          org.olat.core.gui.components.form.flexible.impl.elements.MultiSelectionTree

All Implemented Interfaces:

InlineElement, MultipleSelectionElement, SelectionElement, FormBaseComponentIdProvider, FormItem

public class MultiSelectionTree
extends MultipleSelectionElementImpl
implements MultipleSelectionElement

Description:
TODO: patrickb Class Description for SelectionTree

Initial Date: 21.01.2008

Author:

patrickb

Field Summary

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormItem

ERRORC, EXAMPLEC, LABELC

Fields inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

DISPPREFIX

Constructor Summary

MultiSelectionTree(java.lang.String name, TreeModel treemodel, INodeFilter selectableFilter)

Method Summary

void	reset() reset the data in the field to a initial/predefined value.
void	select(java.lang.String key, boolean select)
void	selectAll() Select all selection elements.
void	setEnabled(boolean isEnabled) item is enabled/disabled, e.g.
void	setKeysAndValues(java.lang.String[] keys, java.lang.String[] values, java.lang.String[] cssClasses)
void	setSelectedValues(java.lang.String[] values) array of values which are selected
void	setVisible(boolean isVisible) item, label, example, error get not visible
void	uncheckAll() Uncheck all selection elements.

Methods inherited from class org.olat.core.gui.components.form.flexible.impl.elements.MultipleSelectionElementImpl

createHorizontalLayout, createSelectboxLayouter, createVerticalLayout, evalFormRequest, getFormDispatchId, getKey, getKeys, getSelectedKeys, getSize, getValue, isAtLeastSelected, isMultiselect, isSelected, setEnabled, setEnabled, setVisible, setVisible, validate

Methods inherited from class org.olat.core.gui.components.form.flexible.impl.FormItemImpl

addActionListener, clearError, doDispatchFormRequest, getAction, getActionListenersFor, getComponent, getEmptyDisplayText, getErrorC, getErrorText, getExampleC, getExampleText, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isInlineEditingOn, isMandatory, isVisible, setEmptyDisplayText, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setRootForm, setTranslator, setUserObject, showError, showExample, showLabel, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.olat.core.gui.components.form.flexible.elements.MultipleSelectionElement

getSelectedKeys, isAtLeastSelected, setEnabled, setEnabled, setVisible, setVisible

Methods inherited from interface org.olat.core.gui.components.form.flexible.elements.SelectionElement

getKey, getSize, getValue, isMultiselect, isSelected

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormItem

addActionListener, clearError, doDispatchFormRequest, evalFormRequest, getAction, getActionListenersFor, getComponent, getErrorC, getErrorText, getExampleC, getExampleText, getLabelC, getLabelText, getName, getRootForm, getTranslator, getUserObject, hasError, hasExample, hasFocus, hasLabel, isEnabled, isMandatory, isVisible, setErrorComponent, setErrorKey, setExampleKey, setFocus, setLabel, setLabelComponent, setMandatory, setRootForm, setTranslator, setUserObject, showError, showExample, showLabel, validate

Methods inherited from interface org.olat.core.gui.components.form.flexible.FormBaseComponentIdProvider

getFormDispatchId

Constructor Detail

MultiSelectionTree

public MultiSelectionTree(java.lang.String name,
                          TreeModel treemodel,
                          INodeFilter selectableFilter)

Method Detail

reset

public void reset()

Description copied from interface: FormItem

reset the data in the field to a initial/predefined value. This method is called if in a form a reset request is issued. It is the counterpart to the validate call which

Specified by:

reset in interface FormItem

Overrides:

reset in class MultipleSelectionElementImpl

See Also:

FormItem.reset()

select

public void select(java.lang.String key,
                   boolean select)

Specified by:

select in interface SelectionElement

Overrides:

select in class MultipleSelectionElementImpl

selectAll

public void selectAll()

Description copied from class: MultipleSelectionElementImpl

Select all selection elements.

Specified by:

selectAll in interface MultipleSelectionElement

Overrides:

selectAll in class MultipleSelectionElementImpl

setEnabled

public void setEnabled(boolean isEnabled)

Description copied from interface: FormItem

item is enabled/disabled, e.g. editable/read only in contrast to setVisible this does NOT DISABLE label, example, error!

Specified by:

setEnabled in interface FormItem

Overrides:

setEnabled in class MultipleSelectionElementImpl

See Also:

org.olat.core.gui.components.form.flexible.FormItemImpl#setEnabled(boolean)

setKeysAndValues

public void setKeysAndValues(java.lang.String[] keys,
                             java.lang.String[] values,
                             java.lang.String[] cssClasses)

Specified by:

setKeysAndValues in interface MultipleSelectionElement

Overrides:

setKeysAndValues in class MultipleSelectionElementImpl

cssClasses - The CSS classes that should be used in the form element for each key-value pair or NULL not not use special styling

setSelectedValues

public void setSelectedValues(java.lang.String[] values)

Description copied from class: MultipleSelectionElementImpl

array of values which are selected

Overrides:

setSelectedValues in class MultipleSelectionElementImpl

setVisible

public void setVisible(boolean isVisible)

Description copied from interface: FormItem

item, label, example, error get not visible

Specified by:

setVisible in interface FormItem

Overrides:

setVisible in class MultipleSelectionElementImpl

uncheckAll

public void uncheckAll()

Description copied from class: MultipleSelectionElementImpl

Uncheck all selection elements.

Specified by:

uncheckAll in interface MultipleSelectionElement

Overrides:

uncheckAll in class MultipleSelectionElementImpl