de.must.appletserver

Class VariableChoiceNumKey

java.lang.Object

de.must.appletserver.RemoteElement

de.must.appletserver.MustComboBox

de.must.appletserver.VariableChoiceNumKey

All Implemented Interfaces:

ActionInterpreter, AppletTalker, Remotable, RemoteContent, Updatable, Exemptible, ExemptibleManager

public class VariableChoiceNumKey
extends MustComboBox

A JComboBox with statically filled content via numeric keys and their descriptions.

Field Summary

Fields inherited from class de.must.appletserver.MustComboBox

editBeginValue, index, items, value

Fields inherited from class de.must.appletserver.RemoteElement

context, editable, enabled, lastEditability, lastVisibility, name, nonstandardPanel, nonstandardPosition, sessionData, toolTipText, visible

Constructor Summary

Constructors

Constructor and Description
VariableChoiceNumKey(SessionData sessionData, KeyValuePairNum[] keyValuePairs) Constructs an new variable choice with the specified content and offer control.
VariableChoiceNumKey(SessionData sessionData, KeyValuePairNum[] keyValuePairs, boolean noChoicePossible) Constructs an new variable choice with the specified content and offer control.
VariableChoiceNumKey(SessionData sessionData, KeyValuePairNum[] keyValuePairs, java.lang.String nameForNoChoice) Constructs an new variable choice with the specified content and offer control.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHelpTarget()
java.lang.String	getHelpTopic()
int	getSelectedItemKey() Returns the key of the selected item.
boolean	isSpecialChoice() Returns true if the selected item is not the placeholder for "none" or "any".
void	setHelpContext(java.lang.String helpTopic) Sets the component's context help.
void	setHelpContext(java.lang.String helpTopic, java.lang.String helpTarget) Sets the component's context help.
void	setNameForNoChoice(java.lang.String noChoiceName) Sets the name for "no choice", e.g.
void	setNoSpecialChoice() Selects the item to be used to indicate "no special choice"
void	setSelectedItemKey(int key) Selects the item by its key.

Methods inherited from class de.must.appletserver.MustComboBox

addItem, addItemListener, buildRemoteView, destroy, fetchValuesFromRequest, getItemAt, getItemCount, getSelectedItem, isModified, perform, removeAllItems, requestFocusInWindow, resetEditBeginValue, selectAll, setSelectedIndex, setSelectedIndexAsEditBeginValue, setSelectedItem, setValues, updateRemoteView

Methods inherited from class de.must.appletserver.RemoteElement

beginAction, endAction, free, getContext, getName, getTranslation, isEnabled, isVisible, register, resetLastStatus, setEditable, setEnabled, setToolTipText, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableChoiceNumKey

public VariableChoiceNumKey(SessionData sessionData,
                            KeyValuePairNum[] keyValuePairs)

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

Parameters:

keyValuePairs - the content as an array of key value pairs

VariableChoiceNumKey

public VariableChoiceNumKey(SessionData sessionData,
                            KeyValuePairNum[] 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"

VariableChoiceNumKey

public VariableChoiceNumKey(SessionData sessionData,
                            KeyValuePairNum[] keyValuePairs,
                            java.lang.String nameForNoChoice)

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

Parameters:

keyValuePairs - the content as an array of key value pairs

nameForNoChoice - the name for "no choice"

Method Detail

setNameForNoChoice

public void setNameForNoChoice(java.lang.String noChoiceName)

Sets the name for "no choice", e.g. ""

Parameters:

noChoiceName - the name for "no choice"

setHelpContext

public void setHelpContext(java.lang.String helpTopic)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

setHelpContext

public void setHelpContext(java.lang.String helpTopic,
                           java.lang.String helpTarget)

Sets the component's context help.

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

public java.lang.String getHelpTopic()

Returns:

the topic of the component's help context

getHelpTarget

public java.lang.String getHelpTarget()

Returns:

the target of the component's help context

getSelectedItemKey

public int getSelectedItemKey()

Returns the key of the selected item.

Returns:

the key of the selected item

setSelectedItemKey

public void setSelectedItemKey(int 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"

setNoSpecialChoice

public void setNoSpecialChoice()

Selects the item to be used to indicate "no special choice"