Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomButton

java.lang.Object

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

de.espirit.firstspirit.access.store.templatestore.gom.GomButton

All Implemented Interfaces:

GomCheckable, GomElement, GomFormElement, GomHideable, GomLangInfoProvider, GomSearchRelevancy, GomTransferHandling, GomTransferReceiver, LineBreakable, Serializable

public class GomButton
extends AbstractGomFormElement
implements GomTransferReceiver, GomTransferHandling

GOM representation of a button

Since:

4.2.426

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GomButton.ButtonStyle	Defines the style of a button
static interface	GomButton.DropMimeType	Drop type
static enum	GomButton.DropType	Predefined drop types
static class	GomButton.GomDropMimeType	Drop type
static class	GomButton.GomDropType	Drop type
static final class	GomButton.GomDropTypes	List of drop types
static final class	GomButton.GomParams	List of GOM parameters
static class	GomButton.ResolveException	Thrown if a class could not be resolved

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_PARAM	Field parameter
static final String	PREFIX_CLASS	Class prefix
static final String	PREFIX_FS	FirstSpirit resource prefix
static final String	PREFIX_MEDIA	Media prefix
static final String	PREFIX_SCRIPT	Script prefix
static final String	TAG	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomButton()

Method Summary

Modifier and Type	Method	Description
boolean	alwaysEnabled()	Convenience API for getAlwaysEnabled() returning a boolean value
boolean	breaks()	Convenience API for AbstractGomFormElement.getNoBreak() returning a boolean value
@NotNull Map<String,String>	fixedParameters()	Convenience API for getParams() returning a map from the parameter name to the text value
YesNo	getAllowEmpty()	Deprecated.
YesNo	getAlwaysEnabled()	Indicates if the button is always enabled or is the form enabled state used
@Nullable Executable	getClickExecutable(@NotNull SpecialistsBroker broker)	The executable used on click events
protected String	getDefaultTag()	Return the default tag for a gom element.
@Nullable Executable	getDropExecutable(@NotNull SpecialistsBroker broker)	The executable used on drop events
@NotNull GomButton.GomDropTypes	getDropTypes()	Allowed drop types
@Nullable String	getIcon()	Icon, either 'info', 'question', or 'media:[uid]'
@Nullable GomButtonScriptReference	getOnClick()	Reference of Executable or Script to be executed on click, or null for no action.
@Nullable GomButtonScriptReference	getOnDrop()	Reference of Executable or Script to be executed on drop, or null for no action.
@NotNull GomButton.GomParams	getParams()	Parameters for the executable
@Nullable GomButton.ButtonStyle	getStyle()	Button style, default is 'button'
@NotNull GomButton.ButtonStyle	getStyleNotNull()	Convenience API for getStyle() returning a non-null value
TransferConstraint	getTransferConstraints(SpecialistsBroker broker)	Returns a TransferConstraint object for this element, which describes the store element based transfer restrictions.
List<TransferType<?>>	getTransferTypes(SpecialistsBroker broker)	Returns a list of supported TransferType's, or null if transfer is not supported.
@NotNull Map<String,Object>	params(@Nullable FormData formData, @NotNull Language language)	Convenience API for getParams() returning a map from parameter name to the text value.
@NotNull Map<String,String>	referencedFields()	Convenience API for getParams() returning a map from the field parameter name to the id
void	setAllowEmpty(YesNo allowEmpty)	Deprecated.
void	setAlwaysEnabled(YesNo value)	Sets if the button is always enabled or is the form enabled state used
void	setIcon(String value)	Sets the icon, either 'info', 'question', or 'media:[uid]'
void	setOnClick(GomButtonScriptReference value)	Setter for OnClick attribute used by GomHandler.
void	setOnDrop(GomButtonScriptReference value)	Setter for OnDrop attribute used by GomHandler.
void	setStyle(GomButton.ButtonStyle value)	Sets the button style
void	validate(GomCheckable.Context context)	Validates the form element's state with respect to the given context.

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

allowsEmpty, clone, convertEntities, description, fillsHorizontally, getConvertEntities, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, verify

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Field Details

PREFIX_SCRIPT

public static final String PREFIX_SCRIPT

Script prefix

Since:

4.2.426

See Also:

• Constant Field Values

PREFIX_CLASS

public static final String PREFIX_CLASS

Class prefix

Since:

4.2.426

See Also:

• Constant Field Values

FIELD_PARAM

public static final String FIELD_PARAM

Field parameter

Since:

4.2.426

See Also:

• Constant Field Values

PREFIX_MEDIA

public static final String PREFIX_MEDIA

Media prefix

Since:

4.2.426

See Also:

• Constant Field Values

PREFIX_FS

public static final String PREFIX_FS

FirstSpirit resource prefix

Since:

4.2.426

See Also:

• FsResource
• Constant Field Values

TAG

public static final String TAG

The tag of this component

Since:

4.2.426

See Also:

• Constant Field Values

Constructor Details

GomButton

public GomButton()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getOnClick

@Nullable
public @Nullable GomButtonScriptReference getOnClick()

Reference of Executable or Script to be executed on click, or null for no action.

Returns:

executable reference string, or null.

Since:

4.2.426

setOnClick

public void setOnClick(GomButtonScriptReference value)

Setter for OnClick attribute used by GomHandler.

Parameters:

value - Reference holder

Since:

4.2.426

getOnDrop

@Nullable
public @Nullable GomButtonScriptReference getOnDrop()

Reference of Executable or Script to be executed on drop, or null for no action.

Returns:

executable reference string, or null.

Since:

4.2.426

setOnDrop

public void setOnDrop(GomButtonScriptReference value)

Setter for OnDrop attribute used by GomHandler.

Parameters:

value - Reference holder

Since:

4.2.426

getIcon

@Nullable
public @Nullable String getIcon()

Icon, either 'info', 'question', or 'media:[uid]'

Since:

4.2.426

setIcon

public void setIcon(String value)

Sets the icon, either 'info', 'question', or 'media:[uid]'

Since:

4.2.426

getStyle

@Nullable
public @Nullable GomButton.ButtonStyle getStyle()

Button style, default is 'button'

Since:

4.2.426

setStyle

public void setStyle(GomButton.ButtonStyle value)

Sets the button style

Since:

4.2.426

getAlwaysEnabled

public YesNo getAlwaysEnabled()

Indicates if the button is always enabled or is the form enabled state used

Since:

4.2.426

setAlwaysEnabled

public void setAlwaysEnabled(YesNo value)

Sets if the button is always enabled or is the form enabled state used

Since:

4.2.426

getParams

@NotNull
public @NotNull GomButton.GomParams getParams()

Parameters for the executable

Since:

4.2.426

getDropTypes

@NotNull
public @NotNull GomButton.GomDropTypes getDropTypes()

Allowed drop types

Since:

4.2.426

getAllowEmpty

@Deprecated
public YesNo getAllowEmpty()

Deprecated.

Description copied from class: AbstractGomFormElement

Indicates, whether the form element allows to stay empty.

Specified by:

getAllowEmpty in interface GomFormElement

Overrides:

getAllowEmpty in class AbstractGomFormElement

Returns:

YES, if empty is allowed. Defaults to YesNo.YES.

setAllowEmpty

@Deprecated
public void setAllowEmpty(YesNo allowEmpty)

Deprecated.

Description copied from class: AbstractGomFormElement

Sets whether empty is allowed for this form element.

Specified by:

setAllowEmpty in interface GomFormElement

Overrides:

setAllowEmpty in class AbstractGomFormElement

Parameters:

allowEmpty - YES, if empty shall be allowed.

validate

public void validate(GomCheckable.Context context)
              throws GomValidationError

Description copied from class: AbstractGomFormElement

Validates the form element's state with respect to the given context. This generic stub does not check anything.

Specified by:

validate in interface GomCheckable

Overrides:

validate in class AbstractGomFormElement

Parameters:

context - The context to validate for, must not be null.

Throws:

GomValidationError - if any requirement is violated.

getTransferConstraints

public TransferConstraint getTransferConstraints(SpecialistsBroker broker)

Description copied from interface: GomTransferReceiver

Returns a TransferConstraint object for this element, which describes the store element based transfer restrictions.

Specified by:

getTransferConstraints in interface GomTransferReceiver

Parameters:

broker - Broker for requesting services or providers.

Returns:

transfer constraint

getTransferTypes

public List<TransferType<?>> getTransferTypes(SpecialistsBroker broker)

Description copied from interface: GomTransferHandling

Returns a list of supported TransferType's, or null if transfer is not supported.

Specified by:

getTransferTypes in interface GomTransferHandling

Parameters:

broker - Broker for requesting services or providers.

Returns:

supported transfer types, or null.

alwaysEnabled

public boolean alwaysEnabled()

Convenience API for getAlwaysEnabled() returning a boolean value

Since:

5.0

referencedFields

@NotNull
public @NotNull Map<String,String> referencedFields()

Convenience API for getParams() returning a map from the field parameter name to the id

Since:

5.0

fixedParameters

@NotNull
public @NotNull Map<String,String> fixedParameters()

Convenience API for getParams() returning a map from the parameter name to the text value

Since:

5.1

params

@NotNull
public @NotNull Map<String,Object> params(@Nullable
 @Nullable FormData formData,
 @NotNull
 @NotNull Language language)

Convenience API for getParams() returning a map from parameter name to the text value. If a FormData instance is provided, its form fields will be used instead of the text value.

Since:

4.2.426

breaks

public boolean breaks()

Convenience API for AbstractGomFormElement.getNoBreak() returning a boolean value

Specified by:

breaks in interface GomFormElement

Specified by:

breaks in interface LineBreakable

Overrides:

breaks in class AbstractGomFormElement

Returns:

true, if the next form element should follow in the next line.

Since:

5.0

getClickExecutable

@Nullable
public @Nullable Executable getClickExecutable(@NotNull
 @NotNull SpecialistsBroker broker)

The executable used on click events

Since:

4.2.426

getDropExecutable

@Nullable
public @Nullable Executable getDropExecutable(@NotNull
 @NotNull SpecialistsBroker broker)

The executable used on drop events

Since:

4.2.426

getStyleNotNull

@NotNull
public @NotNull GomButton.ButtonStyle getStyleNotNull()

Convenience API for getStyle() returning a non-null value

Returns:

the value of getStyle() or GomButton.ButtonStyle.BUTTON if unset

Since:

5.0