de.must.markup

Class MustButton

java.lang.Object

de.must.markup.MustInputField

de.must.markup.MustButton

All Implemented Interfaces:

Markupable, ValueFetcher

Direct Known Subclasses:

BackButton, CancelButton, OkButton, SearchButton

public class MustButton
extends MustInputField

Button. By default, the type is "submit". In this case, the button may be asked wasPressed() after fetchYourValueFromRequest() was executed. This is done best by an instance of GroupOfMarkupables.

See Also:

GroupOfMarkupables

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalTagFragments
protected java.lang.String	className
java.lang.String	imageFileName
int	imageHeight
int	imageWidth
protected java.lang.String	type

Fields inherited from class de.must.markup.MustInputField

comment, focus, name, placeholder, toolTipText

Constructor Summary

Constructors

Constructor and Description
MustButton(java.lang.String label, java.lang.String name) Constructs a new button.
MustButton(java.lang.String label, java.lang.String name, java.lang.String onClickScriptlet) Constructs a new button for a scriptlet to be executed instead of a submit.

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.
boolean	isEnabled() Determines whether this button is enabled.
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	setConfirmationText(java.lang.String confirmationText) Activates the JavaScript confirmation function and sets the confirmation text.
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	setDefaultType(java.lang.String newDefaultType)
void	setEnabled(boolean enabled) Enables or disables this button, depending on the value of the parameter enabled.
void	setSpecialPressedCondition(java.lang.String specialPressedConditionParameterName, java.lang.String specialPressedConditionValue) Sets a special pressed condition - useful for additional logic in JavaScript.
void	setText(java.lang.String text) Sets the button's text.
void	setType(java.lang.String type)
void	setVisible(boolean visible) Sets the visibility of the component.
boolean	wasPressed() True if the button was pressed - auto-initialized - may be asked only once a request.
boolean	wasPressedWithoutInitialization() True if the button was pressed - not auto-initialized - useful for previous plausibility checks - last call to the regular wasPressed recommended.

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

imageFileName

public java.lang.String imageFileName

imageWidth

public int imageWidth

imageHeight

public int imageHeight

type

protected java.lang.String type

className

protected java.lang.String className

additionalTagFragments

protected java.lang.String additionalTagFragments

Constructor Detail

MustButton

public MustButton(java.lang.String label,
                  java.lang.String name)

Constructs a new button.

Parameters:

label - the labe to be seen by the user

name - the name of the button

MustButton

public MustButton(java.lang.String label,
                  java.lang.String name,
                  java.lang.String onClickScriptlet)

Constructs a new button for a scriptlet to be executed instead of a submit. Scriplet buttons cannot support wasPressed().

Parameters:

label - the labe to be seen by the user

name - the name of the button - using # at the end of the name causes sequential instance numbers

onClickScriptlet - the scriptlet to be executed (JavaScript) - if this parameter is not null, the button type is 'button', not 'submit'.

Method Detail

setConfirmationText

public void setConfirmationText(java.lang.String confirmationText)

Activates the JavaScript confirmation function and sets the confirmation text. Sets the button type implicitly to 'button' instead of 'submit'. Needs access to JavaScript function confirmedAction(confirmationText,actionParameterValue) and a hidden field named "actionparm"

 function confirmedAction(confirmationText,actionParameterValue) {
   if (confirm(confirmationText)) {
     document.formname.actionparm.value = actionParameterValue;
     document.formname.submit();
   }
 }
 ...
 

 ...
 
 

Parameters:

confirmationText - The text to be displayed to confirm the action.

setDefaultType

public static void setDefaultType(java.lang.String newDefaultType)

setType

public void setType(java.lang.String type)

setSpecialPressedCondition

public void setSpecialPressedCondition(java.lang.String specialPressedConditionParameterName,
                                       java.lang.String specialPressedConditionValue)

Sets a special pressed condition - useful for additional logic in JavaScript. See constructor with onClickScriptlet

Parameters:

specialPressedConditionParameterName - then name of the parameter to be loaded to check whether the action concernes this button.

specialPressedConditionValue - the value of the parameter to indicate whether the button should be treated as pressed.

setText

public void setText(java.lang.String text)

Sets the button's text.

Parameters:

text - the text (label) of the button

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.

isEnabled

public boolean isEnabled()

Determines whether this button is enabled. An enabled component can respond to user input and generate events. Buttons are enabled initially by default. A component may be enabled or disabled by calling its setEnabled method.

Returns:

true if the button is enabled; false otherwise.

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Enables or disables this button, depending on the value of the parameter enabled. An enabled button can respond to user input and generate events. Components are enabled initially by default.

Parameters:

enabled - If true, this button is enabled; otherwise this button is disabled.

See Also:

isEnabled()

setVisible

public void setVisible(boolean visible)

Sets the visibility of the component.

Parameters:

visible - whether or not the component should be visible

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

wasPressed

public boolean wasPressed()

True if the button was pressed - auto-initialized - may be asked only once a request.

Returns:

true if the button was pressed

wasPressedWithoutInitialization

public boolean wasPressedWithoutInitialization()

True if the button was pressed - not auto-initialized - useful for previous plausibility checks - last call to the regular wasPressed recommended. a request.

Returns:

true if the button was pressed

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