Package com.aquima.interactions.test.templates.composer

Class ButtonReference

java.lang.Object

com.aquima.interactions.test.templates.AbstractReportingTemplate

com.aquima.interactions.test.templates.composer.ElementReference

com.aquima.interactions.test.templates.composer.ButtonReference

public class ButtonReference
extends ElementReference

Template for a reference to a button.

Since:

6.0

Author:

O. Kerpershoek

Constructor Summary

Constructors

Constructor	Description
ButtonReference(ButtonTemplate element)	Constructs a button reference to the specified template.

Method Summary

Modifier and Type	Method	Description
void	addAction(String action)	This method may be used to add an action to a button.
protected String[]	getActions()
ButtonTemplate	getButton()	This method returns the button template that is referred to.
protected String	getEvent()
protected boolean	isRefresh()
void	setEvent(String buttonEvent)	This method may be used to override the button event.
void	setRefreshButton(boolean isRefresh)	This method may be used to indicate if the button should trigger a refresh event.
com.aquima.interactions.composer.ds.IReferenceDS	toDataSource()	This method converts the template to a data source that can be used to initialize a containment reference.

Methods inherited from class com.aquima.interactions.test.templates.composer.ElementReference

addPresentationStyle, addPresentationStyle, getCondition, getContentStyle, getName, getPresentationStyleCondition, getPresentationStyles, getReadonlyCondition, setCondition, setPresentationStyle, setPresentationStyle, setReadonly, setReadonlyCondition

Methods inherited from class com.aquima.interactions.test.templates.AbstractReportingTemplate

getInitializationReport

Methods inherited from class java.lang.Object

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

Constructor Details

ButtonReference

public ButtonReference(ButtonTemplate element)

Constructs a button reference to the specified template.

Parameters:

element - The button template the reference is defined for.

Method Details

getButton

public ButtonTemplate getButton()

This method returns the button template that is referred to.

Returns:

the button template that is referred to.

addAction

public void addAction(String action)

This method may be used to add an action to a button.

Parameters:

action - The action that should be added to the button.

getActions

protected String[] getActions()

getEvent

protected String getEvent()

setEvent

public void setEvent(String buttonEvent)

This method may be used to override the button event.

Parameters:

buttonEvent - the button event.

setRefreshButton

public void setRefreshButton(boolean isRefresh)

This method may be used to indicate if the button should trigger a refresh event.

Parameters:

isRefresh - Boolean indicating if the button should trigger a refresh event.

isRefresh

protected boolean isRefresh()

toDataSource

public com.aquima.interactions.composer.ds.IReferenceDS toDataSource()

Description copied from class: ElementReference

This method converts the template to a data source that can be used to initialize a containment reference.

Specified by:

toDataSource in class ElementReference

Returns:

a data source that can be used to initialize a containment reference.