com.cc.framework.ui.model
Interface ButtonDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel, WebResourceAccess

All Known Subinterfaces:

MenuButtonDesignModel

All Known Implementing Classes:

ButtonDesignModelImp, MenuButtonDesignModelImp

public interface ButtonDesignModel

extends ControlDesignModel, WebResourceAccess

The design model for the Button control The design model holds information for rendering and the layout of the control.

Since:

1.0

Version:

$Revision: 1.12 $

Author:

Gernot Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
int	getButtonStyle() Returns the style for a text button If text buttons with different background images are needed they can be distinguished by the buttonStyle id.
ButtonType	getButtonType() Returns the type of the button
java.lang.String	getSrc() Returns the src.
java.lang.String	getTarget() Returns the target attribute.
java.lang.String	getText() Returns the text.
void	setButtonStyle(int buttonStyle) Sets the button style indicating the background image of the text button
void	setButtonType(ButtonType buttonType) Sets the type of the button
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setSrc(java.lang.String src) Sets the src.
void	setTarget(java.lang.String target) Defines a target attribute.
void	setText(java.lang.String text) Sets the text.

Methods inherited from interface com.cc.framework.ui.model.ControlDesignModel

addDesignRule, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isDisabled, isDynamicDesignModel, isFormElement, setAction, setBorder, setDisabled, setDynamicDesignModel, setFormElement, setHeight, setHelp, setId, setLocaleName, setName, setPermission, setProperty, setRunAt, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabIndex, setTooltip, setTransaction, setWidth

Methods inherited from interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

Methods inherited from interface com.cc.framework.ui.model.AccessControlled

getPermission, show

Methods inherited from interface com.cc.framework.ui.model.ActionBehavior

isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.AjaxSupport

enableAjax, isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.WebResourceAccess

getBase, setBase

Method Detail

getButtonType

public ButtonType getButtonType()

Returns the type of the button

Returns:

The type of the button

setButtonType

public void setButtonType(ButtonType buttonType)

Sets the type of the button

Parameters:

buttonType - The button type

getSrc

public java.lang.String getSrc()

Returns the src.

Returns:

String

setSrc

public void setSrc(java.lang.String src)

Sets the src.

Parameters:

src - The src to set

getText

public java.lang.String getText()

Returns the text.

Returns:

String

setText

public void setText(java.lang.String text)

Sets the text.

Parameters:

text - The text to set

getButtonStyle

public int getButtonStyle()

Returns the style for a text button If text buttons with different background images are needed they can be distinguished by the buttonStyle id.

Returns:

The style

setButtonStyle

public void setButtonStyle(int buttonStyle)

Sets the button style indicating the background image of the text button

Parameters:

buttonStyle - The button style id

filter

public boolean filter()

Returns if the filter is activated (default=true). This means that all Strings which should be displayed in the HTML page are HTML encoded

Returns:

true if string will be HTML encoded; false otherwise

setFilter

public void setFilter(boolean filter)

Activates the HTML encoding (filter). Default is true. This means that all Strings which should be displayed in the HTML page will be HTML encoded.

Parameters:

filter - true if strings should be HTML encoded; false otherwise

setTarget

public void setTarget(java.lang.String target)

Defines a target attribute.

Parameters:

target - The target attribute

getTarget

public java.lang.String getTarget()

Returns the target attribute.

Returns:

The target attribute.