Package com.aquima.interactions.composer

Interface IButton

All Superinterfaces:

IElement, Serializable

All Known Implementing Classes:

Button

public interface IButton
extends IElement

Interface for runtime button elements.

Since:

5.0

Author:

O. Kerpershoek

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LINK	This field contains the static type that is used links.
static final int	REFRESH	This field contains the static type that is used for refresh buttons.
static final int	SUBMIT	This field contains the static type that is used for refresh buttons.

Method Summary

Modifier and Type	Method	Description
String[]	getActions()	This method returns an array of strings containing the events that will be set when the button is clicked.
IMultilingualText	getCaption()	This method returns a multilingual text object that should be used as caption.
String	getEventName()	This method returns the name of the event the button triggers.
int	getType()	This method returns an integer indicating the type of the button.
boolean	isRefresh()	This method returns a boolean indicating if the button triggers a refresh event.

Methods inherited from interface com.aquima.interactions.composer.IElement

accept, duplicate, getName, getParent, getPresentationStyles, getProperty, getPropertyKeys, getRuntimeKey, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent, isVisible, setProperty

Field Details

REFRESH

static final int REFRESH

This field contains the static type that is used for refresh buttons.

See Also:

• Constant Field Values

SUBMIT

static final int SUBMIT

This field contains the static type that is used for refresh buttons.

See Also:

• Constant Field Values

LINK

static final int LINK

This field contains the static type that is used links.

Note: The current version does not yet support buttons of this type.

See Also:

• Constant Field Values

Method Details

getType

int getType()

This method returns an integer indicating the type of the button.

Returns:

an integer indicating the type of the button.

getEventName

String getEventName()

This method returns the name of the event the button triggers. For buttons that do not have a specific event, this method will return null.

Returns:

the name of the event the button triggers.

getActions

String[] getActions()

This method returns an array of strings containing the events that will be set when the button is clicked.

Returns:

an array of strings containing the events that will be set when the button is clicked.

getCaption

IMultilingualText getCaption()

This method returns a multilingual text object that should be used as caption.

Returns:

a multilingual text object that should be used as caption.

isRefresh

boolean isRefresh()

This method returns a boolean indicating if the button triggers a refresh event.

Returns:

a boolean indicating if the button triggers a refresh event.