com.cc.framework.ui.model
Interface ControlDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, DesignModel

All Known Subinterfaces:

ButtonDesignModel, CalendarDesignModel, CheckboxDesignModel, CheckboxGroupDesignModel, ColorPickerDesignModel, ComboBoxDesignModel, ControlContainer, CrumbsDesignModel, FormDesignModel, FrameDesignModel, GaugeDesignModel, HeadlineDesignModel, HiddenDesignModel, InfoDesignModel, ListDesignModel, MenuButtonDesignModel, MenuDesignModel, MessageDesignModel, MultiLevelSelectDesignModel, PanelDesignModel, PlainTextDesignModel, RadioDesignModel, RadioGroupDesignModel, RatingDesignModel, RecurrencePatternDesignModel, SchedulerDesignModel, SelectDesignModel, SpinDesignModel, SwapSelectDesignModel, TabsetDesignModel, TextareaDesignModel, TextDesignModel, TextListDesignModel, TextPopupDesignModel, TreeDesignModel, TreelistDesignModel, TreeSwapSelectDesignModel

All Known Implementing Classes:

ButtonDesignModelImp, CalendarDesignModelImp, CheckboxDesignModelImp, CheckboxGroupDesignModelImp, ColorPickerDesignModelImp, ComboBoxDesignModelImp, ControlContainerImp, ControlDesignModelImp, CrumbsDesignModelImp, FormDesignModelImp, FrameDesignModelImp, GaugeDesignModelImp, HeadlineDesignModelImp, HiddenDesignModelImp, InfoDesignModelImp, ListDesignModelImp, MenuButtonDesignModelImp, MenuDesignModelImp, MessageDesignModelImp, MultiLevelSelectDesignModelImp, PanelDesignModelImp, PlainTextDesignModelImp, RadioDesignModelImp, RadioGroupDesignModelImp, RatingDesignModelImp, RecurrencePatternDesignModelImp, SchedulerDesignModelImp, SelectDesignModelImp, SpinDesignModelImp, SwapSelectDesignModelImp, TabsetDesignModelImp, TextareaDesignModelImp, TextDesignModelImp, TextListDesignModelImp, TextPopupDesignModelImp, TreeDesignModelImp, TreelistDesignModelImp, TreeSwapSelectDesignModelImp

public interface ControlDesignModel

extends DesignModel, ClientHandler, AccessControlled, ActionBehavior, AjaxSupport

Class ControlDesignModel

Version:

$Revision: 1.21 $

Author:

Harald Schulz

Method Summary

void	addDesignRule(DesignRule rule) Adds a new design rule to the control
java.lang.String	getAction() Returns the action which is assigned to the control
int	getBorder() Returns the border width
DesignRule[]	getDesignRules() Returns the design rules for this control
java.lang.String	getHeight() Returns the height of the control
java.lang.String	getHelp() Returns the Help id that is associated with this control element.
java.lang.String	getId() Returns the id of the control
java.lang.String	getLocaleName() Gets the Local Setting for this Control
java.lang.String	getName() Returns the name of the element (bean)
java.lang.String	getProperty() Returns the Property Attribute
RunAt	getRunAt() Returns if the control works with or without server round trips.
java.lang.String	getStyle() Returns the Style
java.lang.String	getStyleClass() Returns the StyleClass
java.lang.String	getStyleId() returns the StyleId
java.lang.String	getSummary() Retrieves the property that can be used for rendering to non-visual media such as speech or Braille
int	getTabIndex() Returns the Tab index
java.lang.String	getTooltip() Retrieves the optional tooltip text
boolean	getTransaction() Checks if the framework should include a transaction token (if any) in all generated hyperlinks.
java.lang.String	getWidth() Returns the width of the control
boolean	hasShadow() Returns if the control uses a shadow
boolean	isDisabled() Returns the disabled Flag
boolean	isDynamicDesignModel() Checks if the design model was declared within the JSP or (design time) it was predetermined by the programmer (run time).
boolean	isFormElement() Checks if the control should act like a form element.
void	setAction(java.lang.String action) Sets the action, which should be performed, if an event of a control occur.
void	setBorder(int border) Sets the border width
void	setDisabled(boolean disabled) Sets the disabled Flag
void	setDynamicDesignModel(boolean dynamic) Sets if the design model was declared within the JSP or (design time) it was predetermined by the programmer (run time).
void	setFormElement(boolean flag) Defines if the control should act like a form element.
void	setHeight(java.lang.String height) Sets the height of the control
void	setHelp(java.lang.String helpId) Associates this control with a help id
void	setId(java.lang.String id) Sets the unique Id for the Control
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this control
void	setName(java.lang.String name) Sets the name of the element (bean)
void	setPermission(Permission permission) Sets a list with permission for the object.
void	setProperty(java.lang.String property) Sets the Property
void	setRunAt(RunAt location) Specified if the control should work with or without server round trips
void	setShadow(boolean shadow) Sets the shadow for a control
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	setSummary(java.lang.String summary) Sets the property that can be used for rendering to non-visual media such as speech or Braille
void	setTabIndex(int tabIndex) Sets the Tab index
void	setTooltip(java.lang.String tooltip) Sets the optional tooltip text
void	setTransaction(boolean transaction) Directs the framework to include a transaction token (if any) in all generated hyperlinks.
void	setWidth(java.lang.String width) Sets the Width of the Control

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

Method Detail

isDynamicDesignModel

public boolean isDynamicDesignModel()

Checks if the design model was declared within the JSP or (design time) it was predetermined by the programmer (run time).

Returns:

true - The design model was set within a JSP page false - The design model was set by the programmer (server side)

setDynamicDesignModel

public void setDynamicDesignModel(boolean dynamic)

Sets if the design model was declared within the JSP or (design time) it was predetermined by the programmer (run time). The framework will use this information to detect if a design model can be created new if a server round trip occurred and if the server side design model should not be changed.

Parameters:

dynamic - true if the design model was declared within the JSP page.

setRunAt

public void setRunAt(RunAt location)

Specified if the control should work with or without server round trips

Parameters:

location - where the action should be executed.

getRunAt

public RunAt getRunAt()

Returns if the control works with or without server round trips.

Returns:

RunAt

setFormElement

public void setFormElement(boolean flag)

Defines if the control should act like a form element.

Parameters:

flag - true if the control should act like a form element.

isFormElement

public boolean isFormElement()

Checks if the control should act like a form element. In this case all action on the control must result in a submission of the enclosing form. This means that the data which is required to detected the actual action on the control (drilldown, edit, ...) must be submit as form data and can not attached to the URL.

Returns:

true if the control acts like a form element.

getName

public java.lang.String getName()

Returns the name of the element (bean)

Returns:

String

setName

public void setName(java.lang.String name)

Sets the name of the element (bean)

Parameters:

name - Name

getProperty

public java.lang.String getProperty()

Returns the Property Attribute

Returns:

String

setProperty

public void setProperty(java.lang.String property)

Sets the Property

Parameters:

property - Property name

setAction

public void setAction(java.lang.String action)

Sets the action, which should be performed, if an event of a control occur.

Parameters:

action - Action

getAction

public java.lang.String getAction()

Returns the action which is assigned to the control

Returns:

String

getHeight

public java.lang.String getHeight()

Returns the height of the control

Returns:

String

getId

public java.lang.String getId()

Returns the id of the control

Returns:

String

getWidth

public java.lang.String getWidth()

Returns the width of the control

Returns:

String

setHeight

public void setHeight(java.lang.String height)

Sets the height of the control

Parameters:

height - Height

setId

public void setId(java.lang.String id)

Sets the unique Id for the Control

Parameters:

id - Id

setWidth

public void setWidth(java.lang.String width)

Sets the Width of the Control

Parameters:

width - Width

getBorder

public int getBorder()

Returns the border width

Returns:

integer

setBorder

public void setBorder(int border)

Sets the border width

Parameters:

border - Border

hasShadow

public boolean hasShadow()

Returns if the control uses a shadow

Returns:

boolean

setShadow

public void setShadow(boolean shadow)

Sets the shadow for a control

Parameters:

shadow - true if the control should render a shadow

setDisabled

public void setDisabled(boolean disabled)

Sets the disabled Flag

Parameters:

disabled - true if the control should be rendered as inactive

isDisabled

public boolean isDisabled()

Returns the disabled Flag

Returns:

boolean

setStyle

public void setStyle(java.lang.String style)

Sets the Style

Parameters:

style - Style constant

getStyle

public java.lang.String getStyle()

Returns the Style

Returns:

String

setStyleId

public void setStyleId(java.lang.String styleId)

Sets the StyleId

Parameters:

styleId - HTML-Id of the element

getStyleId

public java.lang.String getStyleId()

returns the StyleId

Returns:

string

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the StyleClass

Parameters:

styleClass - StyleClass

getStyleClass

public java.lang.String getStyleClass()

Returns the StyleClass

Returns:

String

getHelp

public java.lang.String getHelp()

Returns the Help id that is associated with this control element. If a control has a help id a little icon with a link to the help system will be created

Returns:

String returns the Help id of the element. The semantic of this id is completely in the responsibility of the applications help system

setHelp

public void setHelp(java.lang.String helpId)

Associates this control with a help id

Parameters:

helpId - The Help Help id of the element. The semantic of this id is completely in the responsibility of the applications help system

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the optional tooltip text

Parameters:

tooltip - Tooltip

getTooltip

public java.lang.String getTooltip()

Retrieves the optional tooltip text

Returns:

tooltip text or null

getTabIndex

public int getTabIndex()

Returns the Tab index

Returns:

integer

setTabIndex

public void setTabIndex(int tabIndex)

Sets the Tab index

Parameters:

tabIndex - Index

setPermission

public void setPermission(Permission permission)

Sets a list with permission for the object. Permissions are separated by ';'

Parameters:

permission - Permission

setLocaleName

public void setLocaleName(java.lang.String locale)

Sets the Locale configuration for this control

Parameters:

locale - Locale Identifier or true|false

getLocaleName

public java.lang.String getLocaleName()

Gets the Local Setting for this Control

Returns:

Locale Setting

addDesignRule

public void addDesignRule(DesignRule rule)

Adds a new design rule to the control

Parameters:

rule - Design rule

getDesignRules

public DesignRule[] getDesignRules()

Returns the design rules for this control

Returns:

Array of design rules

setSummary

public void setSummary(java.lang.String summary)

Sets the property that can be used for rendering to non-visual media such as speech or Braille

Parameters:

summary - specifies a description and/or structure of the object.

getSummary

public java.lang.String getSummary()

Retrieves the property that can be used for rendering to non-visual media such as speech or Braille

Returns:

receives a description and/or structure of the object or null

setTransaction

public void setTransaction(boolean transaction)

Directs the framework to include a transaction token (if any) in all generated hyperlinks. The Transaction token is used to track form re-submissions.

Parameters:

transaction - include transaction token

getTransaction

public boolean getTransaction()

Checks if the framework should include a transaction token (if any) in all generated hyperlinks. The Transaction token is used to track form re-submissions.

Specified by:

getTransaction in interface ActionBehavior

Returns:

true if the transaction token should be generated