Package com.aquima.interactions.composer.model

Class Link

java.lang.Object

com.aquima.interactions.composer.model.Element

com.aquima.interactions.composer.model.Link

All Implemented Interfaces:

IElement, Serializable

public class Link
extends Element

Page element containing the information of the link that should be shown on the page.

Since:

6.0

Author:

J. van Leuven

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.aquima.interactions.composer.model.Element

name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Link(Link other)
	Link(String typeName, TextItem textItem)	Constructs the link with the required arguments.
	Link(String typeName, IMultilingualText text)	Constructs the link with the required arguments.

Method Summary

Modifier and Type	Method	Description
IVisitor	accept(IVisitor visitor)	This method will invoke the visitor for this runtime element.
void	addParameter(String key, IPrimitiveValue parameterValue)	This method may be used to add a parameter to the link.
Element	duplicate()	This method should clone the element and return the cloned element.
boolean	equals(Object o)
String[]	getParameterKeys()	This method returns an array containing the names of the parameters that are defined for this link.
IPrimitiveValue	getParameterValue(String key)	This method returns the value for the specified parameter name.
IMultilingualText	getText()	This method returns the text that should be shown for the link.
TextItem	getTextItem()	This method returns the text that should be shown for the link.
String	getTypeName()	This method returns the (type) name of the link.
int	hashCode()

Methods inherited from class com.aquima.interactions.composer.model.Element

addPresentationStyle, evaluateTsl, getName, getParent, getPresentationStyles, getProperty, getPropertyKeys, getRuntimeKey, getVisibilityCondition, hasFocus, hasPresentationStyle, isReadonly, isReadonlyInheritFromParent, isVisible, setFocus, setParent, setPresentationStyle, setPresentationStyles, setPresentationStyles, setProperty, setReadonly, setReadonlyInheritFromParent, setRuntimeKey, setVisibilityCondition, setVisible

Methods inherited from class java.lang.Object

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

Constructor Details

Link

public Link(String typeName,
 IMultilingualText text)

Constructs the link with the required arguments.

Parameters:

typeName - The name of the link element.

text - The text that should be shown for the link.

Link

public Link(String typeName,
 TextItem textItem)

Constructs the link with the required arguments.

Parameters:

typeName - The name of the link element.

textItem - The text that should be shown for the link.

Link

protected Link(Link other)

Method Details

duplicate

public Element duplicate()

Description copied from interface: IElement

This method should clone the element and return the cloned element. The duplicate method should usually make a deep copy of the element, with the exception of members that are not mutable (and thus can safely be shared between multiple copies). The properties of an element are considered to be non-mutable, and will thus by default be copied.

Returns:

The cloned (duplicate) element.

addParameter

public void addParameter(String key,
 IPrimitiveValue parameterValue)

This method may be used to add a parameter to the link.

Parameters:

key - The name of the parameter.

parameterValue - The value of the parameter.

getParameterKeys

public String[] getParameterKeys()

This method returns an array containing the names of the parameters that are defined for this link.

Returns:

an array containing the names of the parameters that are defined for this link.

getParameterValue

public IPrimitiveValue getParameterValue(String key)

This method returns the value for the specified parameter name. When there is no parameter defined with the specified name, a null value will be returned.

Parameters:

key - The name of the parameter for which the value is requested.

Returns:

The value for the specified parameter, or null if no value parameter is present with the specified name.

getText

public IMultilingualText getText()

This method returns the text that should be shown for the link.

Returns:

the text that should be shown for the link.

getTextItem

public TextItem getTextItem()

This method returns the text that should be shown for the link.

Returns:

the text that should be shown for the link.

getTypeName

public String getTypeName()

This method returns the (type) name of the link.

Returns:

the (type) name of the link.

equals

public boolean equals(Object o)

Overrides:

equals in class Element

hashCode

public int hashCode()

Overrides:

hashCode in class Element

accept

public IVisitor accept(IVisitor visitor)

Description copied from class: Element

This method will invoke the visitor for this runtime element.

Specified by:

accept in interface IElement

Overrides:

accept in class Element

Parameters:

visitor - The visitor that should be invoked.

Returns:

The visitor passed to this method.