com.cc.framework.ui.painter
Interface ActionPainter

All Known Implementing Classes:

DefActionPainter

public interface ActionPainter

The ActionPainter Class is responsible to generate a HTML-Element to initiate an Action

Since:

1.0

Version:

$Revision: 1.53 $

Author:

Harald Schulz

Method Summary

void	addEventHandler(ClientEvent event, java.lang.String handler) Adds an additional event handler to this painter
void	addParameter(boolean value) Method addParameter
void	addParameter(java.lang.Boolean value) Method addParameter
void	addParameter(int value) Method addParameter
void	addParameter(java.lang.Integer value) Method addParameter
void	addParameter(long value) Method addParameter
void	addParameter(java.lang.Long value) Method addParameter
void	addParameter(java.lang.Object obj) Method addParameter
void	addParameter(java.lang.String value) Method addParameter
org.apache.ecs.ConcreteElement	createElement() Creates an HTML Element which makes it possible to choose the Action on the user interface.
ControlAction	getAction() return the Action
java.lang.String	getAnchor()
ImageModel	getImage() Returns the Image
AlignmentType	getImageAlign() Returns the alignment of an additional image
java.lang.String	getImageStyle()
AlignmentType	getImageVAlign() Returns the vertical alignment of an additional image
java.lang.String	getLabel() Returns the Label
java.lang.String	getLinkName()
java.lang.String	getStyle() Returns the Style
java.lang.String	getStyleClass() Returns the StyleClass
java.lang.String	getStyleId() Returns the StyleId
java.lang.String	getTarget() Returns the Target
java.lang.String	getTooltip() Returns the Tooltip
boolean	isActive() Returns the Active Flag
boolean	isFormAction() Returns the form action Flag
void	setActive(boolean b) Sets the Active Flag
void	setAnchor(java.lang.String anchor) Sets the Anchor to appended to the URL (#anchor)
void	setBehavior(ActionBehavior behavior) Sets some information about the actions behavior.
void	setClientHandler(ClientHandler handler) sets the Client Event Handlers
void	setImage(ImageModel image) Sets the Image
void	setImageAlign(AlignmentType type) Sets the alignment of an additional image
void	setImageStyle(java.lang.String style) Sets an additional image Style
void	setImageVAlign(AlignmentType type) Sets the vertical alignment of an additional image
void	setLabel(java.lang.String label) Sets the Label.
void	setLinkName(java.lang.String linkName) The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks.
void	setStyle(java.lang.String style) Sets the Style
void	setStyleClass(java.lang.String styleClass) Sets the StyleClass
void	setStyleId(java.lang.String styleId) Sets the StyleId
void	setTarget(java.lang.String target) Sets the Target
void	setTooltip(java.lang.String tooltip) Sets the ToolTip

Method Detail

addEventHandler

public void addEventHandler(ClientEvent event,
                            java.lang.String handler)

Adds an additional event handler to this painter

Parameters:

event - Event

handler - ScriptCode

addParameter

public void addParameter(boolean value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(java.lang.Boolean value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(int value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(java.lang.Integer value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(long value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(java.lang.Long value)

Method addParameter

Parameters:

value - Value

addParameter

public void addParameter(java.lang.Object obj)

Method addParameter

Parameters:

obj - Object

addParameter

public void addParameter(java.lang.String value)

Method addParameter

Parameters:

value - Value

createElement

public org.apache.ecs.ConcreteElement createElement()

Creates an HTML Element which makes it possible to choose the Action on the user interface.

Returns:

ConcreteElement

getAction

public ControlAction getAction()

return the Action

Returns:

ControlAction

getAnchor

public java.lang.String getAnchor()

Returns:

the Anchor to appended to the URL (#anchor)

getImage

public ImageModel getImage()

Returns the Image

Returns:

ImageModel

getImageAlign

public AlignmentType getImageAlign()

Returns the alignment of an additional image

Returns:

AlignmentType

getImageStyle

public java.lang.String getImageStyle()

Returns:

an additional image Style

getImageVAlign

public AlignmentType getImageVAlign()

Returns the vertical alignment of an additional image

Returns:

AlignmentType

getLabel

public java.lang.String getLabel()

Returns the Label

Returns:

String

getLinkName

public java.lang.String getLinkName()

Returns:

The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag.

getStyle

public java.lang.String getStyle()

Returns the Style

Returns:

String

getStyleClass

public java.lang.String getStyleClass()

Returns the StyleClass

Returns:

String

getStyleId

public java.lang.String getStyleId()

Returns the StyleId

Returns:

String

getTarget

public java.lang.String getTarget()

Returns the Target

Returns:

String

getTooltip

public java.lang.String getTooltip()

Returns the Tooltip

Returns:

String

isActive

public boolean isActive()

Returns the Active Flag

Returns:

boolean

isFormAction

public boolean isFormAction()

Returns the form action Flag

Returns:

boolean returns true when this action link should submit the enclosing HTML form

setActive

public void setActive(boolean b)

Sets the Active Flag

Parameters:

b - Flag

setAnchor

public void setAnchor(java.lang.String anchor)

Sets the Anchor to appended to the URL (#anchor)

Parameters:

anchor - Anchor

setClientHandler

public void setClientHandler(ClientHandler handler)

sets the Client Event Handlers

Parameters:

handler - Client Handler

setImage

public void setImage(ImageModel image)

Sets the Image

Parameters:

image - ImageModel

setImageAlign

public void setImageAlign(AlignmentType type)

Sets the alignment of an additional image

Parameters:

type - Alignment Type

setImageStyle

public void setImageStyle(java.lang.String style)

Sets an additional image Style

Parameters:

style - Image style

setImageVAlign

public void setImageVAlign(AlignmentType type)

Sets the vertical alignment of an additional image

Parameters:

type - Alignment Type

setLabel

public void setLabel(java.lang.String label)

Sets the Label. If necessary the label must be HTML encoded and localized first. This is not done by the ActionPainter

Parameters:

label - Label

setLinkName

public void setLinkName(java.lang.String linkName)

The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag.

Parameters:

linkName - Link Name

setStyle

public void setStyle(java.lang.String style)

Sets the Style

Parameters:

style - Style

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the StyleClass

Parameters:

styleClass - StyleClass

setStyleId

public void setStyleId(java.lang.String styleId)

Sets the StyleId

Parameters:

styleId - StyleId

setTarget

public void setTarget(java.lang.String target)

Sets the Target

Parameters:

target - Target

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the ToolTip

Parameters:

tooltip - ToolTip

setBehavior

public void setBehavior(ActionBehavior behavior)

Sets some information about the actions behavior.

Parameters:

behavior - Directs the framework to include a transaction token (if any) in all generated hyperlinks. The Transaction token is used to track form re-submissions. enables the AJAX handlers for this action