de.must.appletserver

Class HalfDataComboBox

java.lang.Object

de.must.appletserver.RemoteElement

de.must.appletserver.MustComboBox

de.must.appletserver.HalfDataComboBox

All Implemented Interfaces:

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

Direct Known Subclasses:

DataComboBox, ParamHalfDataComboBox

public class HalfDataComboBox
extends MustComboBox
implements DataChangeListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HalfDataComboBox.Variant The variant builder wrapper to simplify construction detail definition.

Field Summary

Fields

Modifier and Type	Field and Description
protected Callback	callbackIfTableChanged
protected boolean	containsNoSpecification
protected DataObject	contentDataObject
protected boolean	contentIsToRenew
protected Identifier	editBeginValue
protected java.lang.String	filterCondition
protected IdentifierTextTable	identifierTable
protected java.lang.String	inactiveColumnName
protected java.lang.String	nameForNoChoice
protected java.lang.String[]	orderByColumnNames
static java.lang.String	SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE
protected java.lang.String[]	specialChoices
protected java.lang.String[]	visibleColumnNames
protected java.util.Hashtable<Identifier,java.lang.String>	weakItems
static int	WIDTH_FITTING_TO_CONTENT

Fields inherited from class de.must.appletserver.MustComboBox

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
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, boolean fillWhileConstruction) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, HalfDataComboBox.Variant variant) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, boolean fillWhileConstruction) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice, int width) Constructs a new combo box.
HalfDataComboBox(SessionData sessionData, DataObject sourceDataObject, java.lang.String visibleColumnName, java.lang.String orderByColumnName, java.lang.String nameForNoChoice, int width, boolean fillWhileConstruction, boolean containsNoSpecification) Constructs a new combo box.

Method Summary

Modifier and Type	Method and Description
void	addItem(java.lang.String item, Identifier identifier) Adds an item to the combo box.
void	dataChangePerformed(DataChangedEvent e)
void	destroy() Don't wait until garbage collector removed weak reference.
protected void	fill() Fills or refills the content of the data combo box by reading the source data object.
void	fill(java.lang.String whereCondition) Fills or refills the content of the data combo box by reading the source data object.
protected void	finalize()
void	free() Frees external resources.
Identifier	getSelectedIdentifier() Returns the identifier of the selected entry.
java.lang.String	getSelectedItemWithoutNameForNoChoice() Returns the selected item as String after replacing '' by ''.
protected java.lang.String	getTranslation(java.lang.String resourceKey) Returns a text in the corresponding language according to the locale specific resource bundle of the package.
boolean	isFilled() Returns true if the component has a value.
boolean	isModified() Indicates whether the component's value differs from its initial value.
boolean	isSpecialChoice() Returns true if the selected item is not the placeholder for "none" or "any".
void	reloadContentIfIsToRenew(ToAppletWriter out) Reloads content if it is to renew, which is e.g. the case if an item has been added to the source data object.
void	removeAllItems()
void	selectAll() Selects all input of the component, if it is supported - e.g. in JTextField.
void	setFilterCondition(java.lang.String filterCondition) Sets the filter condition, e.g. not to present entries declared as inactive
void	setFilterCondition(java.lang.String columnName, boolean booleanValue) Sets a boolean filter condition, e.g. not to present entries declared as inactive - uses the appropriate SQL value to build the comparison string
void	setInactiveColumnName(java.lang.String inactiveColumnName) Sets the column name to determine inactive items.
void	setNoSpecialChoice() Selects the item to be used to indicate "no special choice"
boolean	setSelectedIdentifier(Identifier selectedIdentifier) Selects an item by the identifier.
void	setSelectedIdentifierAsBeginValue(Identifier identifier) Selects an item of the combo box by identifier.
void	setSpecialChoices(java.lang.String[] specialChoices) Sets special choices to be displayed after 'name for no choice' and values from source data object.
void	setValues(ToAppletWriter out)

Methods inherited from class de.must.appletserver.MustComboBox

addItem, addItemListener, buildRemoteView, fetchValuesFromRequest, getItemAt, getItemCount, getSelectedItem, perform, requestFocusInWindow, resetEditBeginValue, setSelectedIndex, setSelectedIndexAsEditBeginValue, setSelectedItem, updateRemoteView

Methods inherited from class de.must.appletserver.RemoteElement

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

Methods inherited from class java.lang.Object

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

Field Detail

SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE

public static final java.lang.String SPECIAL_NAME_FOR_NO_CHOICE_WHICH_MEANS_NOT_APPLICABLE

See Also:

Constant Field Values

WIDTH_FITTING_TO_CONTENT

public static final int WIDTH_FITTING_TO_CONTENT

See Also:

Constant Field Values

contentDataObject

protected DataObject contentDataObject

visibleColumnNames

protected java.lang.String[] visibleColumnNames

orderByColumnNames

protected java.lang.String[] orderByColumnNames

nameForNoChoice

protected java.lang.String nameForNoChoice

specialChoices

protected java.lang.String[] specialChoices

containsNoSpecification

protected boolean containsNoSpecification

filterCondition

protected java.lang.String filterCondition

inactiveColumnName

protected java.lang.String inactiveColumnName

identifierTable

protected IdentifierTextTable identifierTable

editBeginValue

protected Identifier editBeginValue

weakItems

protected java.util.Hashtable<Identifier,java.lang.String> weakItems

contentIsToRenew

protected boolean contentIsToRenew

callbackIfTableChanged

protected Callback callbackIfTableChanged

Constructor Detail

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        HalfDataComboBox.Variant variant)

Constructs a new combo box.

Parameters:

sourceDataObject - the source data object

variant - the wrapper containing variant definitions.

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        boolean fillWhileConstruction)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

fillWhileConstruction - whether or not this combo box should be filled while construction process

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        boolean fillWhileConstruction)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

fillWhileConstruction - whether or not this combo box should be filled while construction process

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice,
                        int width)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

width - the width of the component - if 0 it's automatically sized

HalfDataComboBox

public HalfDataComboBox(SessionData sessionData,
                        DataObject sourceDataObject,
                        java.lang.String visibleColumnName,
                        java.lang.String orderByColumnName,
                        java.lang.String nameForNoChoice,
                        int width,
                        boolean fillWhileConstruction,
                        boolean containsNoSpecification)

Constructs a new combo box.

Parameters:

sessionData - the session data

sourceDataObject - the source data object

visibleColumnName - the name of the column to be displayed

orderByColumnName - the sorting column name of the content data object

nameForNoChoice - the expression to be used to indicate "no choice"

width - the width of the component - if 0 it's automatically sized

fillWhileConstruction - whether or not this combo box should be filled while construction process

containsNoSpecification - TODO

Method Detail

setSpecialChoices

public void setSpecialChoices(java.lang.String[] specialChoices)

Sets special choices to be displayed after 'name for no choice' and values from source data object. This can only work with IdentifyTemplate.IDENTIFIED_BY_STRING!

Parameters:

specialChoices - the specialChoices to set.

setFilterCondition

public void setFilterCondition(java.lang.String columnName,
                               boolean booleanValue)

Sets a boolean filter condition, e.g. not to present entries declared as inactive - uses the appropriate SQL value to build the comparison string

Parameters:

columnName - the column name for the boolean condition

booleanValue - the boolean value to select

setFilterCondition

public void setFilterCondition(java.lang.String filterCondition)

Sets the filter condition, e.g. not to present entries declared as inactive

Parameters:

filterCondition - the condition to reduce the content

setInactiveColumnName

public void setInactiveColumnName(java.lang.String inactiveColumnName)

Sets the column name to determine inactive items. Inactive items will only be presented if assigned.

Parameters:

inactiveColumnName - the name to determine inactive items

getTranslation

protected java.lang.String getTranslation(java.lang.String resourceKey)

Returns a text in the corresponding language according to the locale specific resource bundle of the package.

Overrides:

getTranslation in class RemoteElement

Parameters:

resourceKey - the key of the resource to retrieve

Returns:

the resource

removeAllItems

public void removeAllItems()

Overrides:

removeAllItems in class MustComboBox

fill

protected void fill()

Fills or refills the content of the data combo box by reading the source data object.

fill

public void fill(java.lang.String whereCondition)

Fills or refills the content of the data combo box by reading the source data object.

Parameters:

whereCondition - the where condition to shorten the content

reloadContentIfIsToRenew

public void reloadContentIfIsToRenew(ToAppletWriter out)

Reloads content if it is to renew, which is e.g. the case if an item has been added to the source data object.

Parameters:

out - the response writer

setValues

public void setValues(ToAppletWriter out)

Specified by:

setValues in interface RemoteContent

Overrides:

setValues in class MustComboBox

selectAll

public void selectAll()

Selects all input of the component, if it is supported - e.g. in JTextField. Allows easy new input, because the previous value is reset when the first key stroke occurs.

Specified by:

selectAll in interface RemoteContent

Overrides:

selectAll in class MustComboBox

addItem

public void addItem(java.lang.String item,
                    Identifier identifier)

Adds an item to the combo box.

Parameters:

item - the item to add

identifyValueInt - the identifier of the item to add

setSelectedIdentifier

public boolean setSelectedIdentifier(Identifier selectedIdentifier)

Selects an item by the identifier.

Parameters:

selectedIdentifier - the identifier to select an entry

Returns:

true

setSelectedIdentifierAsBeginValue

public void setSelectedIdentifierAsBeginValue(Identifier identifier)

Selects an item of the combo box by identifier.

Parameters:

selectIdentifier - the identifier (primary key) of the item to select

getSelectedIdentifier

public Identifier getSelectedIdentifier()

Returns the identifier of the selected entry.

Returns:

the identifier of the selected entry

getSelectedItemWithoutNameForNoChoice

public java.lang.String getSelectedItemWithoutNameForNoChoice()

Returns the selected item as String after replacing '' by ''.

Returns:

the selected item as String after replacing '' by ''

isFilled

public boolean isFilled()

Returns true if the component has a value.

Returns:

true if the component has a value

isModified

public boolean isModified()

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

Overrides:

isModified in class MustComboBox

Returns:

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

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"

dataChangePerformed

public void dataChangePerformed(DataChangedEvent e)

Specified by:

dataChangePerformed in interface DataChangeListener

destroy

public void destroy()

Description copied from interface: Remotable

Don't wait until garbage collector removed weak reference.

Specified by:

destroy in interface Remotable

Overrides:

destroy in class MustComboBox

free

public void free()

Frees external resources. May be called manually without waiting for the garbage collector.

Specified by:

free in interface Exemptible

Specified by:

free in interface ExemptibleManager

Overrides:

free in class RemoteElement

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable