com.cc.framework.ui.model
Interface FormDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ButtonContainer, ClientHandler, ControlDesignModel, DesignModel, FormElement, FormElementContainer, FrameContainer

All Known Implementing Classes:

FormDesignModelImp

public interface FormDesignModel

extends ControlDesignModel, FormElementContainer, FrameContainer

Interface for the FormDesignModel

Version:

$Revision: 1.13 $

Author:

Harald Schulz

Method Summary

java.lang.String	getAction() Returns the Action
java.lang.String	getCaption() Returns the Caption of the Form
java.lang.String	getDetail() Returns the Detail, which is displayed right of the Caption
java.lang.String	getFormId() Returns the form identifier
FormType	getFormType() Returns the FormType
ImageMap	getImageMap() Returns the ImageMap
java.lang.String	getLabelPrefix() Retrieves the optional label prefix in plain HTML.
java.lang.String	getLabelSuffix() Retrieves the optional label suffix in plain HTML.
FormMethod	getMethod() Returns in which way Data should by submitted to the Server.
void	setAction(java.lang.String action) Sets the Action
void	setCaption(java.lang.String caption) Sets the Caption
void	setDetail(java.lang.String detail) Sets the Detail
void	setFormId(java.lang.String formid) Sets the form identifier
void	setFormType(FormType type) Sets the FormType
void	setImageMap(ImageMap map) Sets the ImageMap
void	setLabelPrefix(java.lang.String prefix) Specifies the label prefix in plain HTML.
void	setLabelSuffix(java.lang.String suffix) Specifies the label suffix in plain HTML.
void	setMethod(FormMethod method) Sets the FormMethod

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

addDesignRule, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isDisabled, isDynamicDesignModel, isFormElement, 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.control.FormElementContainer

addFormElement, getCellWidth, getColumnGroup, getExpandProperty, getFormElement, getFormElements, getFormElements, getLabelWidth, getOrientation, removeFormElement, setCellWidth, setExpandProperty, setLabelWidth, setShowFrame, showFrame, size

Methods inherited from interface com.cc.framework.ui.control.FormElement

getAlignment, getColSpan, getHeight, getHelp, getNoWrap, getParent, getStyle, getStyleClass, getStyleId, getVAlignment, getWidth, joinElements, setAlignment, setColSpan, setHeight, setHelp, setJoin, setParent, setStyle, setStyleClass, setStyleId, setVAlignment, setWidth

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

addInnerFrame, getImage, getInnerFrames, setImage

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

getButtonPermission, setButtonPermission, showButton

Method Detail

getFormId

public java.lang.String getFormId()

Returns the form identifier

Returns:

String

setFormId

public void setFormId(java.lang.String formid)

Sets the form identifier

Parameters:

formid - Id

getAction

public java.lang.String getAction()

Returns the Action

Specified by:

getAction in interface ControlDesignModel

Returns:

String

setAction

public void setAction(java.lang.String action)

Sets the Action

Specified by:

setAction in interface ControlDesignModel

Parameters:

action - Action

getMethod

public FormMethod getMethod()

Returns in which way Data should by submitted to the Server.

Returns:

FormMethod

setMethod

public void setMethod(FormMethod method)

Sets the FormMethod

Parameters:

method - FormMethod

getFormType

public FormType getFormType()

Returns the FormType

Returns:

FormType

setFormType

public void setFormType(FormType type)

Sets the FormType

Parameters:

type - FormType

getCaption

public java.lang.String getCaption()

Returns the Caption of the Form

Returns:

String

setCaption

public void setCaption(java.lang.String caption)

Sets the Caption

Parameters:

caption - Caption

getDetail

public java.lang.String getDetail()

Returns the Detail, which is displayed right of the Caption

Returns:

String

setDetail

public void setDetail(java.lang.String detail)

Sets the Detail

Parameters:

detail - Detail String

setImageMap

public void setImageMap(ImageMap map)

Sets the ImageMap

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the ImageMap

Returns:

ImageMap

getLabelPrefix

public java.lang.String getLabelPrefix()

Retrieves the optional label prefix in plain HTML. This attribute can be overwritten at form element level.

Returns:

Prefix (plain HTML) or null

setLabelPrefix

public void setLabelPrefix(java.lang.String prefix)

Specifies the label prefix in plain HTML. This attribute can be overwritten at form element level.

Parameters:

prefix - The label prefix

getLabelSuffix

public java.lang.String getLabelSuffix()

Retrieves the optional label suffix in plain HTML. This attribute can be overwritten at form element level.

Returns:

Suffix (plain HTML) or null

setLabelSuffix

public void setLabelSuffix(java.lang.String suffix)

Specifies the label suffix in plain HTML. This attribute can be overwritten at form element level.

Parameters:

suffix - The label suffix