de.must.markup

Class MustCheckBox

java.lang.Object

de.must.markup.MustInputField

de.must.markup.MustCheckBox

All Implemented Interfaces:

Markupable, ValueFetcher

Direct Known Subclasses:

DataCheckBox

public class MustCheckBox
extends MustInputField

CheckBox for boolean value administration.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalTagFragments
protected java.lang.String	checkText
protected boolean	editable
protected boolean	enabled

Fields inherited from class de.must.markup.MustInputField

comment, focus, name, placeholder, toolTipText

Constructor Summary

Constructors

Constructor and Description
MustCheckBox(java.lang.String checkText) Constructs a new check box with the check text as specified.
MustCheckBox(java.lang.String name, java.lang.String checkText) Constructs a new check box with the specified name and check text.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the markupable.
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	getSelectedYN() Returns Y if the checkbox is selected and N if not.
boolean	isFilled() Returns true if the component has a value.
boolean	isModified() Returns true if the component's value differs from its initial value.
boolean	isRequired() Returns always false.
boolean	isRequirementUnfulfilled() Returns false if mandatory input Field is not filled.
boolean	isSelected() Returns true if the checkbox is selected.
boolean	isValid() Returns true if the component's value is valid.
void	resetModifiedStatus() Resets the modified status by setting the editBeginValue to the current value.
void	setAdditionalTagFragments(java.lang.String additionalTagFragments) Sets the component's additional tag fragments.
static void	setDefaultAdditionalTagFragments(java.lang.String newDefaultAdditionalTagFragments) Sets the component's default additional tag fragments.
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	setOnClickScript(java.lang.String newOnClickScript) Sets the component's javascript function for the onClick event.
void	setRequired(boolean required) Sets the fact that user input is requested (mandatory)
void	setSelected(boolean selected) Sets the checkbox state as specified.
void	setSelected(java.lang.String yn) Sets the checkbox state as specified.

Methods inherited from class de.must.markup.MustInputField

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

checkText

protected java.lang.String checkText

additionalTagFragments

protected java.lang.String additionalTagFragments

editable

protected boolean editable

enabled

protected boolean enabled

Constructor Detail

MustCheckBox

public MustCheckBox(java.lang.String checkText)

Constructs a new check box with the check text as specified.

Parameters:

checkText - the check box' text

MustCheckBox

public MustCheckBox(java.lang.String name,
                    java.lang.String checkText)

Constructs a new check box with the specified name and check text.

Parameters:

name - the name of the check box

checkText - the check box' text

Method Detail

setOnClickScript

public void setOnClickScript(java.lang.String newOnClickScript)

Sets the component's javascript function for the onClick event.

Parameters:

newOnClick - the component's javascript function for the onClick event

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.

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

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

isSelected

public boolean isSelected()

Returns true if the checkbox is selected.

Returns:

true if the checkbox is selected

setSelected

public void setSelected(java.lang.String yn)

Sets the checkbox state as specified.

Parameters:

yn - indicates via "Y" or "N" whether the check box is to be selected.

setSelected

public void setSelected(boolean selected)

Sets the checkbox state as specified.

Parameters:

selected - indicates whether the check box is to be selected.

getSelectedYN

public java.lang.String getSelectedYN()

Returns Y if the checkbox is selected and N if not.

Returns:

Y if the checkbox is selected and N if not

setRequired

public void setRequired(boolean required)

Sets the fact that user input is requested (mandatory)

Parameters:

required - whether this inuput is mandatory or not.

isRequired

public boolean isRequired()

Returns always false.

Returns:

always false

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 false if mandatory input Field is not filled.

Returns:

if mandatory input is unfulfilled

isModified

public boolean isModified()

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

Returns:

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

resetModifiedStatus

public void resetModifiedStatus()

Resets the modified status by setting the editBeginValue to the current value.

destroy

public void destroy()

Description copied from interface: Markupable

Destroys the markupable. Useful to release e.g. static references which prevent the garbage collector from finalizing. For example HalfDataComboBoxes add s as Listeners to database changes. These listeners are registered statically. Thus, these listeners cannot be removed by the garbage collector, they have to be removed manually. This may be done by calling this destroy method.

Specified by:

destroy in interface Markupable

Overrides:

destroy in class MustInputField

See Also:

Markupable.destroy()