de.must.markup

Class VariableChoice

java.lang.Object

de.must.markup.MustInputField

de.must.markup.VariableChoice

All Implemented Interfaces:

Markupable, ValueFetcher

Direct Known Subclasses:

DataVariableChoice

public class VariableChoice
extends MustInputField

Equivalent to a JComboBox with statically filled content with keys and their descriptions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalTagFragments
protected java.lang.String	className
protected java.lang.String[][]	content
protected boolean	editable
protected java.lang.String	editBeginValue
protected boolean	enabled
protected int	format
protected static int	FORMAT_KEY_INVISIBLE
protected static int	FORMAT_KEY_VISIBLE
protected java.lang.String	label
protected boolean	required
protected java.lang.String	selected
protected java.lang.String	selectedItemKey
protected java.lang.String	visibleColumnName

Fields inherited from class de.must.markup.MustInputField

comment, focus, name, placeholder, toolTipText

Constructor Summary

Constructors

Constructor and Description
VariableChoice() Constructs an new automatically named variable choice to be filler later by setContent();
VariableChoice(KeyValuePair[] keyValuePairs) Constructs an new variable choice with the specified content.
VariableChoice(KeyValuePair[] keyValuePairs, boolean noChoicePossible) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String name) Constructs an new variable choice with the specified name and items.
VariableChoice(java.lang.String[] items) Constructs an new automatically named variable choice with the specified items.
VariableChoice(java.lang.String[][] content) Constructs an new automatically named variable choice with the specified items.
VariableChoice(java.lang.String name, KeyValuePair[] keyValuePairs) Constructs an new variable choice with the specified name and items.
VariableChoice(java.lang.String name, KeyValuePair[] keyValuePairs, boolean noChoicePossible) Constructs an new variable choice with the specified content and offer control.
VariableChoice(java.lang.String name, java.lang.String[] items) Constructs an new variable choice with the specified name and items.
VariableChoice(java.lang.String name, java.lang.String[][] content) Constructs an new variable choice with the specified name and content.
VariableChoice(java.util.Vector<java.lang.String> items) Constructs an new automatically named variable choice

Method Summary

Modifier and Type	Method and Description
void	fetchYourValueFromRequest(GeneralizedRequest request) Causes the component to read user input by calling request.getParameter and update the internal mirrored value.
java.lang.String	getCreationTag() Returns the tag sequence that's needed to show this object in the user interface.
java.lang.String	getLabel() Returns the component's label.
int	getSelectedIndex() Returns the index of first item in the list that matches the given item.
java.lang.String	getSelectedItem() Returns the selected item.
java.lang.String	getSelectedItemKey() Returns the key of the selected item.
boolean	isFilled() Returns true if the component has a value.
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isRequirementUnfulfilled() Returns true if the component's value is mandatory but not filled.
boolean	isSpecialChoice() Returns true if the selected item is not the placeholder for "none" or "any".
boolean	isValid() Returns true if the component's value is valid.
void	setAdditionalTagFragments(java.lang.String additionalTagFragments) Sets the component's additional tag fragments.
void	setClassName(java.lang.String className) Sets the component's class name - may be used to assign formatting via stylesheets.
void	setContent(java.lang.String[] items) Sets the content of the variable choice.
void	setContent(java.lang.String[][] content) Sets the content of the variable choice.
void	setContent(java.util.Vector<java.lang.String> items) Sets the content of the variable choice.
static void	setDefaultAdditionalTagFragments(java.lang.String newDefaultAdditionalTagFragments) Sets the component's default additional tag fragments.
static void	setDefaultClassName(java.lang.String newDefaultClassName) Sets the component's default class name - may be used to assign formatting via stylesheets.
static void	setDefaultNameForNoChoice(java.lang.String newDefaultNameForNoChoice) Sets the defaultNameForNoChoice.
void	setEditable(boolean editable) Sets the specified boolean to indicate whether or not this component should be editable.
void	setEnabled(boolean enabled) Sets the specified boolean to indicate whether or not this component is enabled.
void	setName(java.lang.String name) Sets the component's name via stylesheets.
void	setRequired(boolean required) Sets the fact that user input is requested (mandatory)
void	setSelected(java.lang.String stringToSelect) Selects the item by string to select.
void	setSelectedIndex(int anIndex) Selects the item by string to select.
void	setSelectedItemKey(java.lang.String key) Selects the item by its key.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class de.must.markup.MustInputField

destroy, getName, setComment, setFocus, setPlaceHolder, setToolTipText, toString

Methods inherited from class java.lang.Object

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

Field Detail

label

protected java.lang.String label

required

protected boolean required

className

protected java.lang.String className

additionalTagFragments

protected java.lang.String additionalTagFragments

visibleColumnName

protected java.lang.String visibleColumnName

content

protected java.lang.String[][] content

selected

protected java.lang.String selected

selectedItemKey

protected java.lang.String selectedItemKey

editBeginValue

protected java.lang.String editBeginValue

editable

protected boolean editable

enabled

protected boolean enabled

FORMAT_KEY_VISIBLE

protected static final int FORMAT_KEY_VISIBLE

See Also:

Constant Field Values

FORMAT_KEY_INVISIBLE

protected static final int FORMAT_KEY_INVISIBLE

See Also:

Constant Field Values

format

protected int format

Constructor Detail

VariableChoice

public VariableChoice(java.lang.String name)

Constructs an new variable choice with the specified name and items.

Parameters:

name - component's name

VariableChoice

public VariableChoice()

Constructs an new automatically named variable choice to be filler later by setContent();

VariableChoice

public VariableChoice(java.util.Vector<java.lang.String> items)

Constructs an new automatically named variable choice

Parameters:

items - the static items of the choice.

VariableChoice

public VariableChoice(java.lang.String[] items)

Constructs an new automatically named variable choice with the specified items.

Parameters:

items - the static items of the choice.

VariableChoice

public VariableChoice(java.lang.String name,
                      java.lang.String[] items)

Constructs an new variable choice with the specified name and items.

Parameters:

name - component's name

items - the static items of the choice.

VariableChoice

public VariableChoice(KeyValuePair[] keyValuePairs)

Constructs an new variable choice with the specified content.

Parameters:

keyValuePairs - the content as an array of key value pairs

VariableChoice

public VariableChoice(java.lang.String name,
                      KeyValuePair[] keyValuePairs)

Constructs an new variable choice with the specified name and items.

Parameters:

name - component's name

keyValuePairs - the content as an array of key value pairs

items - the static items of the choice.

VariableChoice

public VariableChoice(KeyValuePair[] keyValuePairs,
                      boolean noChoicePossible)

Constructs an new variable choice with the specified content and offer control.

Parameters:

keyValuePairs - the content as an array of key value pairs

noChoicePossible - if true, an item is offered which represents the "no choice"

VariableChoice

public VariableChoice(java.lang.String name,
                      KeyValuePair[] keyValuePairs,
                      boolean noChoicePossible)

Constructs an new variable choice with the specified content and offer control.

Parameters:

name - component's name

keyValuePairs - the content as an array of key value pairs

noChoicePossible - if true, an item is offered which represents the "no choice"

VariableChoice

public VariableChoice(java.lang.String[][] content)

Constructs an new automatically named variable choice with the specified items.

Parameters:

items - the static items of the choice.

VariableChoice

public VariableChoice(java.lang.String name,
                      java.lang.String[][] content)

Constructs an new variable choice with the specified name and content.

Parameters:

name - component's name

content - the statically filled content, each line is a pair of key and value.

Method Detail

setDefaultNameForNoChoice

public static void setDefaultNameForNoChoice(java.lang.String newDefaultNameForNoChoice)

Sets the defaultNameForNoChoice.

Parameters:

defaultNameForNoChoice - The defaultNameForNoChoice to set

setDefaultClassName

public static void setDefaultClassName(java.lang.String newDefaultClassName)

Sets the component's default class name - may be used to assign formatting via stylesheets.

Parameters:

newDefaultClassName - the component's default class name

setClassName

public void setClassName(java.lang.String className)

Sets the component's class name - may be used to assign formatting via stylesheets.

Parameters:

newDefaultClassName - the component's class name

setDefaultAdditionalTagFragments

public static void setDefaultAdditionalTagFragments(java.lang.String newDefaultAdditionalTagFragments)

Sets the component's default additional tag fragments. E.g. JavaScript like onChange may be added.

Parameters:

newDefaultClassName - the component's default additional tag fragments.

setAdditionalTagFragments

public void setAdditionalTagFragments(java.lang.String additionalTagFragments)

Sets the component's additional tag fragments. E.g. JavaScript like onChange may be added.

Parameters:

newDefaultClassName - the component's additional tag fragments.

setName

public void setName(java.lang.String name)

Sets the component's name via stylesheets.

Parameters:

name - the component's name

setEditable

public void setEditable(boolean editable)

Sets the specified boolean to indicate whether or not this component should be editable.

Parameters:

editable - indicates whether or not this component is editable

setEnabled

public void setEnabled(boolean enabled)

Sets the specified boolean to indicate whether or not this component is enabled.

Parameters:

enabled - indicates whether or not this component is enabled

setVisible

public void setVisible(boolean visible)

Sets the visibility of the component.

Parameters:

visible - whether or not the component should be visible

setContent

public void setContent(java.lang.String[][] content)

Sets the content of the variable choice.

Parameters:

content - the statically filled content, each line is a pair of key and value

setContent

public void setContent(java.lang.String[] items)

Sets the content of the variable choice.

Parameters:

items - the static items of the choice.

setContent

public void setContent(java.util.Vector<java.lang.String> items)

Sets the content of the variable choice.

Parameters:

items - the static items of the choice as a vector of Strings

setSelectedIndex

public void setSelectedIndex(int anIndex)

Selects the item by string to select.

Parameters:

stringToSelect - the string to select

setSelected

public void setSelected(java.lang.String stringToSelect)

Selects the item by string to select.

Parameters:

stringToSelect - the string to select

getLabel

public java.lang.String getLabel()

Returns the component's label.

Returns:

the component's label

getCreationTag

public java.lang.String getCreationTag()

Returns the tag sequence that's needed to show this object in the user interface.

Returns:

the tag sequence to show the component

fetchYourValueFromRequest

public void fetchYourValueFromRequest(GeneralizedRequest request)

Causes the component to read user input by calling request.getParameter and update the internal mirrored value.

Specified by:

fetchYourValueFromRequest in interface ValueFetcher

Specified by:

fetchYourValueFromRequest in class MustInputField

Parameters:

request - the current request

getSelectedIndex

public int getSelectedIndex()

Returns the index of first item in the list that matches the given item.

Returns:

the index of first item in the list that matches the given item

getSelectedItem

public java.lang.String getSelectedItem()

Returns the selected item.

Returns:

the selected item

getSelectedItemKey

public java.lang.String getSelectedItemKey()

Returns the key of the selected item.

Returns:

the key of the selected item

setSelectedItemKey

public void setSelectedItemKey(java.lang.String key)

Selects the item by its key.

Parameters:

key - the key of the item to select

isSpecialChoice

public boolean isSpecialChoice()

Returns true if the selected item is not the placeholder for "none" or "any".

Returns:

true if the selected item is not the placeholder for "none" or "any"

setRequired

public void setRequired(boolean required)

Sets the fact that user input is requested (mandatory)

Parameters:

required - whether this inuput is mandatory or not.

isFilled

public boolean isFilled()

Returns true if the component has a value.

Returns:

true if the component has a value

isValid

public boolean isValid()

Returns true if the component's value is valid.

Returns:

true if the component's value is valid

isRequirementUnfulfilled

public boolean isRequirementUnfulfilled()

Returns true if the component's value is mandatory but not filled.

Returns:

if mandatory input is unfulfilled

isModified

public boolean isModified()

Indicates whether the component's value differs from its initial value.

Returns:

true if the component's value differs from its initial value