de.must.wuic

Class MustMultChoice

java.lang.Object

de.must.wuic.MustMultChoice

All Implemented Interfaces:

ModifiedInformer, ContextHelp

public class MustMultChoice
extends java.lang.Object
implements ContextHelp, ModifiedInformer

A component to assign multiple keys via checkbox list.

Field Summary

Fields

Modifier and Type	Field and Description
protected MustMultChoiceModel	mainTableModel
protected javax.swing.JTable	table

Constructor Summary

Constructors

Constructor and Description
MustMultChoice(DataObject Key, java.lang.String[] keyColumns, java.lang.String[] keyHeaders) Constructs a new multiple choice component.

Method Summary

Modifier and Type	Method and Description
void	free() Releases external resources.
java.lang.String	getHelpTarget()
java.lang.String	getHelpTopic()
MustMultChoiceModel	getModel() Returns the multiple choice model.
java.lang.String	getSnapshot() Returns a snapshot of user's choice to be recovered by reset(String).
javax.swing.JTable	getTable() Returns the table e.g. to be added to a viewport.
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	isValid() Returns true if the component's value is valid.
void	requestFocus() Set focus on the receiving component if isRequestFocusEnabled returns true.
void	reset(java.lang.String snapshot) Recovers some user choice represented by a snapshot build by getSnapshot().
void	selectAll() Selects all input of the component, if it is supported - e.g. in JTextField.
void	setAllFalse() Sets all selections to false.
void	setEditable(boolean editable) Sets the flag that determines whether or not this component is editable.
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	setPreferedColumnSize(int[] cs) Sets the preferred column sizes of the table.
void	setRequired(boolean required) Sets the previously added component to be mandatory.
void	synchronize(MustMultChoice MustMultChoiceToSynchronize)

Methods inherited from class java.lang.Object

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

Field Detail

table

protected javax.swing.JTable table

mainTableModel

protected MustMultChoiceModel mainTableModel

Constructor Detail

MustMultChoice

public MustMultChoice(DataObject Key,
                      java.lang.String[] keyColumns,
                      java.lang.String[] keyHeaders)

Constructs a new multiple choice component.

Parameters:

key - the key containing data object, e.g. a group

keyColumns - the columns of the key table to be displayed

keyHeaders - the headers of the table which represents the keys

Method Detail

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.

Specified by:

setHelpContext in interface ContextHelp

Parameters:

helpTopic - the context help's topic

helpTarget - the context help's target

getHelpTopic

public java.lang.String getHelpTopic()

Specified by:

getHelpTopic in interface ContextHelp

Returns:

the topic of the component's help context

getHelpTarget

public java.lang.String getHelpTarget()

Specified by:

getHelpTarget in interface ContextHelp

Returns:

the target of the component's help context

getTable

public javax.swing.JTable getTable()

Returns the table e.g. to be added to a viewport.

Returns:

the table e.g. to be added to a viewport

setPreferedColumnSize

public void setPreferedColumnSize(int[] cs)

Sets the preferred column sizes of the table.

Parameters:

cs - contains the sizes of the displayable columns from left to right

getModel

public MustMultChoiceModel getModel()

Returns the multiple choice model.

Returns:

the multiple choice model

setRequired

public void setRequired(boolean required)

Sets the previously added component to be mandatory.

Parameters:

required - whether the component is mandatory or not

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()

Description copied from interface: ModifiedInformer

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

Specified by:

isModified in interface ModifiedInformer

Returns:

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

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.

requestFocus

public void requestFocus()

Set focus on the receiving component if isRequestFocusEnabled returns true.

getSnapshot

public java.lang.String getSnapshot()

Returns a snapshot of user's choice to be recovered by reset(String).

Returns:

a snapshot of user's choice to be recovered by reset(String)

reset

public void reset(java.lang.String snapshot)

Recovers some user choice represented by a snapshot build by getSnapshot().

Parameters:

snapshot - the snapshot the represents former user choice

setAllFalse

public void setAllFalse()

Sets all selections to false.

setEditable

public void setEditable(boolean editable)

Sets the flag that determines whether or not this component is editable. If the flag is set to true, this component becomes user editable. If the flag is set to false, the cannot change the text of this text component.

Parameters:

editable - a flag indicating whether this component should be user editable

synchronize

public void synchronize(MustMultChoice MustMultChoiceToSynchronize)

Parameters:

MustMultChoiceToSynchronize -

free

public void free()

Releases external resources.