org.xmlactions.pager.actions.form

Class Link

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.pager.actions.form.Link

All Implemented Interfaces:

java.lang.Cloneable, IDraw, ILink

public class Link
extends BaseAction
implements IDraw, ILink, java.lang.Cloneable

Container class for html links.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DISPLAY_AS_BUTTON
static java.lang.String	DISPLAY_AS_LINK
static java.lang.String	DISPLAY_AS_MENU

Fields inherited from class org.xmlactions.action.actions.BaseAction

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
Link()

Method Summary

Modifier and Type	Method and Description
static HtmlImg	buildImage(ILink iImage) build an HtmlImg
java.lang.Object	clone()
Html	draw(IExecContext execContext, Theme theme) Draw the Element
java.lang.String	execute(IExecContext execContext) Executes an action
java.lang.String	getActionScript()
java.lang.String	getActionText()
java.lang.String	getBorder() width of border if using an image
java.lang.String	getDisplay_as()
java.lang.String	getHeader()
java.lang.String	getHref()
java.lang.String	getId()
java.lang.String	getImage_height() may want to specify the height image
java.lang.String	getImage_pos() if there is text this can be used to set the position of the image on the left or the right of the text.
java.lang.String	getImage_width() may want to specify the width of the link.button
java.lang.String	getImage() can also display an image as part of the link
java.lang.String	getIs_allowed()
java.lang.String	getName()
java.lang.String	getTarget()
java.lang.String	getTooltip()
java.lang.String	getUri()
java.lang.String	getUri(IExecContext execContext)
java.lang.String	getWidth()
boolean	isRemove_crlf()
boolean	isSubmit()
static Link	newLink(ILink iLink, java.lang.String name)
static Link	newLink(ILink iImage, java.lang.String name, java.lang.String display_as, java.lang.String tooltip)
static Link	newLink(java.lang.String name)
static Link	newLink(java.lang.String name, java.lang.String display_as)
static Link	newLink(java.lang.String name, java.lang.String display_as, java.lang.String tooltip)
void	setActionScript(java.lang.String actionScript)
void	setActionText(java.lang.String actionText)
void	setBorder(java.lang.String border) width of border if using an image
void	setDisplay_as(java.lang.String display_as)
void	setHeader(java.lang.String header)
void	setHref(java.lang.String href)
void	setId(java.lang.String id)
void	setImage_height(java.lang.String image_height) may want to specify the height image
void	setImage_pos(java.lang.String image_pos) if there is text this can be used to set the position of the image on the left or the right of the text.
void	setImage_width(java.lang.String image_width) may want to specify the width of the link.button
void	setImage(java.lang.String image) can also display an image as part of the link
void	setIs_allowed(java.lang.String is_allowed)
void	setName(java.lang.String name)
void	setRemove_crlf(boolean removeCrlf)
void	setSubmit(boolean submit)
void	setTarget(java.lang.String target)
void	setTooltip(java.lang.String tooltip)
void	setUri(java.lang.String uri)
void	setWidth(java.lang.String width)

Methods inherited from class org.xmlactions.action.actions.BaseAction

addChild, clearActions, doReplace, doReplace, getActions, getChild, getContent, getFirstValueFound, getParent, getReplacementContent, getReplacementMarker, isUsedForDisplay, processAction, setAction, setActions, setChild, setContent, setParent, setReplacementContent, setReplacementMarker, setUsedForDisplay

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_AS_BUTTON

public static final java.lang.String DISPLAY_AS_BUTTON

See Also:

Constant Field Values

DISPLAY_AS_LINK

public static final java.lang.String DISPLAY_AS_LINK

See Also:

Constant Field Values

DISPLAY_AS_MENU

public static final java.lang.String DISPLAY_AS_MENU

See Also:

Constant Field Values

Constructor Detail

Link

public Link()

Method Detail

newLink

public static Link newLink(java.lang.String name)

newLink

public static Link newLink(java.lang.String name,
                           java.lang.String display_as)

newLink

public static Link newLink(java.lang.String name,
                           java.lang.String display_as,
                           java.lang.String tooltip)

newLink

public static Link newLink(ILink iLink,
                           java.lang.String name)

newLink

public static Link newLink(ILink iImage,
                           java.lang.String name,
                           java.lang.String display_as,
                           java.lang.String tooltip)

execute

public java.lang.String execute(IExecContext execContext)

Description copied from class: BaseAction

Executes an action

Specified by:

execute in class BaseAction

Parameters:

execContext - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

draw

public Html draw(IExecContext execContext,
                 Theme theme)

Description copied from interface: IDraw

Draw the Element

Specified by:

draw in interface IDraw

Returns:

an HTML object

getUri

public java.lang.String getUri()

getUri

public java.lang.String getUri(IExecContext execContext)

setUri

public void setUri(java.lang.String uri)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setSubmit

public void setSubmit(boolean submit)

isSubmit

public boolean isSubmit()

setActionText

public void setActionText(java.lang.String actionText)

getActionText

public java.lang.String getActionText()

setActionScript

public void setActionScript(java.lang.String actionScript)

getActionScript

public java.lang.String getActionScript()

setDisplay_as

public void setDisplay_as(java.lang.String display_as)

Specified by:

setDisplay_as in interface ILink

getDisplay_as

public java.lang.String getDisplay_as()

Specified by:

getDisplay_as in interface ILink

setTooltip

public void setTooltip(java.lang.String tooltip)

Specified by:

setTooltip in interface ILink

getTooltip

public java.lang.String getTooltip()

Specified by:

getTooltip in interface ILink

isRemove_crlf

public boolean isRemove_crlf()

setRemove_crlf

public void setRemove_crlf(boolean removeCrlf)

setHeader

public void setHeader(java.lang.String header)

getHeader

public java.lang.String getHeader()

setHref

public void setHref(java.lang.String href)

Specified by:

setHref in interface ILink

getHref

public java.lang.String getHref()

Specified by:

getHref in interface ILink

setTarget

public void setTarget(java.lang.String target)

getTarget

public java.lang.String getTarget()

setWidth

public void setWidth(java.lang.String width)

getWidth

public java.lang.String getWidth()

setImage

public void setImage(java.lang.String image)

Description copied from interface: ILink

can also display an image as part of the link

Specified by:

setImage in interface ILink

getImage

public java.lang.String getImage()

Description copied from interface: ILink

can also display an image as part of the link

Specified by:

getImage in interface ILink

setBorder

public void setBorder(java.lang.String border)

Description copied from interface: ILink

width of border if using an image

Specified by:

setBorder in interface ILink

getBorder

public java.lang.String getBorder()

Description copied from interface: ILink

width of border if using an image

Specified by:

getBorder in interface ILink

setImage_pos

public void setImage_pos(java.lang.String image_pos)

Description copied from interface: ILink

if there is text this can be used to set the position of the image on the left or the right of the text.

Specified by:

setImage_pos in interface ILink

getImage_pos

public java.lang.String getImage_pos()

Description copied from interface: ILink

if there is text this can be used to set the position of the image on the left or the right of the text.

Specified by:

getImage_pos in interface ILink

setImage_width

public void setImage_width(java.lang.String image_width)

Description copied from interface: ILink

may want to specify the width of the link.button

Specified by:

setImage_width in interface ILink

getImage_width

public java.lang.String getImage_width()

Description copied from interface: ILink

may want to specify the width of the link.button

Specified by:

getImage_width in interface ILink

setImage_height

public void setImage_height(java.lang.String image_height)

Description copied from interface: ILink

may want to specify the height image

Specified by:

setImage_height in interface ILink

getImage_height

public java.lang.String getImage_height()

Description copied from interface: ILink

may want to specify the height image

Specified by:

getImage_height in interface ILink

getIs_allowed

public java.lang.String getIs_allowed()

setIs_allowed

public void setIs_allowed(java.lang.String is_allowed)

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

buildImage

public static HtmlImg buildImage(ILink iImage)

build an HtmlImg

Returns:

an HtmlImg object created from the associated class atributes.