com.cc.framework.ui.control
Class FormButtonElement

java.lang.Object
  com.cc.framework.ui.model.imp.ClientHandlerImp
      com.cc.framework.ui.model.imp.ControlDesignModelImp
          com.cc.framework.ui.model.imp.ButtonDesignModelImp
              com.cc.framework.ui.control.FormButtonElement

All Implemented Interfaces:

AccessControlled, ActionBehavior, AjaxSupport, ButtonDesignModel, ClientHandler, ControlDesignModel, DesignModel, FormElement, java.io.Serializable, WebResourceAccess

public class FormButtonElement

extends ButtonDesignModelImp

implements FormElement

Used for a button within a form

Since:

1.0

Version:

$Revision: 1.23 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private AlignmentType	alignment The horizontal alignment of the form element
private int	colspan The ColumnSpan of this element
private boolean	def Indicates if this is the default button on the form.
private boolean	join This flag indicates that this element should be joined with the preceding element without a separator
private FormElementContainer	parent The parent container
private static long	serialVersionUID Serial Version UID
private AlignmentType	valignment The vertical alignment of the form element

Fields inherited from class com.cc.framework.ui.model.imp.ButtonDesignModelImp

Fields inherited from class com.cc.framework.ui.model.imp.ControlDesignModelImp

Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

Constructor Summary

FormButtonElement()
Constructor

Method Summary

AlignmentType	getAlignment() Returns the horizontal alignment
int	getColSpan() Returns the column span for this element
boolean	getNoWrap() Indicates that the form element cell should not be wrapped
FormElementContainer	getParent()
AlignmentType	getVAlignment() Returns the vertical alignment
boolean	isDefault() Returns the asDefault.
boolean	joinElements() This method returns true when two adjacent form elements should be joined together without a separator
void	setAlignment(AlignmentType alignment) Specifies the horizontal alignment of the form element within the form left right center
void	setColSpan(int colspan) Sets the column span of this form element
void	setDefault(boolean def) Sets the asDefault.
void	setJoin(boolean join) This method specifies that two adjacent form elements should be joined together without a separator
void	setParent(FormElementContainer parent)
void	setVAlignment(AlignmentType valignment) Specifies the vertical alignment of the form element within the form top bottom center

Methods inherited from class com.cc.framework.ui.model.imp.ButtonDesignModelImp

filter, getBase, getButtonStyle, getButtonType, getSrc, getTarget, getText, setBase, setButtonStyle, setButtonType, setFilter, setSrc, setTarget, setText

Methods inherited from class com.cc.framework.ui.model.imp.ControlDesignModelImp

addDesignRule, enableAjax, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getPermission, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isAjaxEnabled, 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, show

Methods inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

evaluate, getHandler, getHandlers, setHandler

Methods inherited from class java.lang.Object

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

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

getHeight, getHelp, getStyle, getStyleClass, getStyleId, getWidth, setHeight, setHelp, setStyle, setStyleClass, setStyleId, setWidth

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

getPermission, show

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.ActionBehavior

isAjaxEnabled

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

enableAjax, isAjaxEnabled

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

parent

private FormElementContainer parent

The parent container

def

private boolean def

Indicates if this is the default button on the form.

colspan

private int colspan

The ColumnSpan of this element

join

private boolean join

This flag indicates that this element should be joined with the preceding element without a separator

alignment

private AlignmentType alignment

The horizontal alignment of the form element

valignment

private AlignmentType valignment

The vertical alignment of the form element

Constructor Detail

FormButtonElement

public FormButtonElement()

Constructor

Method Detail

getParent

public FormElementContainer getParent()

Specified by:

getParent in interface FormElement

Returns:

returns the parent container or null when this is the top most container

See Also:

FormElement.getParent()

setParent

public void setParent(FormElementContainer parent)

Specified by:

setParent in interface FormElement

Parameters:

parent - the parent form element container for this element

See Also:

FormElement.setParent(com.cc.framework.ui.control.FormElementContainer)

isDefault

public boolean isDefault()

Returns the asDefault.

Returns:

boolean

setDefault

public void setDefault(boolean def)

Sets the asDefault.

Parameters:

def - The asDefault to set

getColSpan

public int getColSpan()

Description copied from interface: FormElement

Returns the column span for this element

Specified by:

getColSpan in interface FormElement

Returns:

column span

See Also:

FormElement.getColSpan()

setColSpan

public void setColSpan(int colspan)

Description copied from interface: FormElement

Sets the column span of this form element

Specified by:

setColSpan in interface FormElement

Parameters:

colspan - column span

See Also:

FormElement.setColSpan(int)

joinElements

public boolean joinElements()

Description copied from interface: FormElement

This method returns true when two adjacent form elements should be joined together without a separator

Specified by:

joinElements in interface FormElement

Returns:

true when the form elements should be joined

See Also:

FormElement.joinElements()

setJoin

public void setJoin(boolean join)

Description copied from interface: FormElement

This method specifies that two adjacent form elements should be joined together without a separator

Specified by:

setJoin in interface FormElement

Parameters:

join - true when the form elements should be joined

See Also:

FormElement.setJoin(boolean)

getAlignment

public AlignmentType getAlignment()

Description copied from interface: FormElement

Returns the horizontal alignment

Specified by:

getAlignment in interface FormElement

Returns:

alignment

See Also:

FormElement.getAlignment()

getVAlignment

public AlignmentType getVAlignment()

Description copied from interface: FormElement

Returns the vertical alignment

Specified by:

getVAlignment in interface FormElement

Returns:

alignment

See Also:

FormElement.getVAlignment()

setAlignment

public void setAlignment(AlignmentType alignment)

Description copied from interface: FormElement

Specifies the horizontal alignment of the form element within the form

• left
• right
• center

Specified by:

setAlignment in interface FormElement

Parameters:

alignment - The alignment of the element

See Also:

FormElement.setAlignment(com.cc.framework.ui.AlignmentType)

setVAlignment

public void setVAlignment(AlignmentType valignment)

Description copied from interface: FormElement

Specifies the vertical alignment of the form element within the form

• top
• bottom
• center

Specified by:

setVAlignment in interface FormElement

Parameters:

valignment - The alignment of the element

See Also:

FormElement.setVAlignment(com.cc.framework.ui.AlignmentType)

getNoWrap

public boolean getNoWrap()

Description copied from interface: FormElement

Indicates that the form element cell should not be wrapped

Specified by:

getNoWrap in interface FormElement

Returns:

Boolean

See Also:

FormElement.getNoWrap()