com.cc.framework.ui.control
Interface FormElement

All Superinterfaces:

AccessControlled

All Known Subinterfaces:

FormDesignModel, FormElementContainer, LabeledFormElement

All Known Implementing Classes:

FormButtonElement, FormControlElement, FormDesignModelImp, FormGroupElement, FormHtmlElement, FormMessageElement

public interface FormElement

extends AccessControlled

Base Interface for all form elements

Since:

1.0

Version:

$Revision: 1.15 $

Author:

Harald Schulz

Method Summary

AlignmentType	getAlignment() Returns the horizontal alignment
int	getColSpan() Returns the column span for this element
java.lang.String	getHeight() Returns the height of the form element (pixel or %)
java.lang.String	getHelp() Returns the Help id that is associated with this form element.
boolean	getNoWrap() Indicates that the form element cell should not be wrapped
FormElementContainer	getParent()
java.lang.String	getStyle() Returns the Style
java.lang.String	getStyleClass() Returns the StyleClass
java.lang.String	getStyleId() returns the StyleId
AlignmentType	getVAlignment() Returns the vertical alignment
java.lang.String	getWidth() Returns the width of the form element (pixel or %)
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	setHeight(java.lang.String height) Sets the height of the form element (pixel or %)
void	setHelp(java.lang.String helpId) Associates this form element with a help id
void	setJoin(boolean join) This method specifies that two adjacent form elements should be joined together without a separator
void	setParent(FormElementContainer parent)
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	setVAlignment(AlignmentType valignment) Specifies the vertical alignment of the form element within the form top bottom center
void	setWidth(java.lang.String width) Sets the width of the form element (pixel or %)

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

getPermission, show

Method Detail

getParent

public FormElementContainer getParent()

Returns:

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

setParent

public void setParent(FormElementContainer parent)

Parameters:

parent - the parent form element container for this element

getNoWrap

public boolean getNoWrap()

Indicates that the form element cell should not be wrapped

Returns:

Boolean

getColSpan

public int getColSpan()

Returns the column span for this element

Returns:

column span

setColSpan

public void setColSpan(int colspan)

Sets the column span of this form element

Parameters:

colspan - column span

joinElements

public boolean joinElements()

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

Returns:

true when the form elements should be joined

setJoin

public void setJoin(boolean join)

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

Parameters:

join - true when the form elements should be joined

setWidth

public void setWidth(java.lang.String width)

Sets the width of the form element (pixel or %)

Parameters:

width - The Width

getWidth

public java.lang.String getWidth()

Returns the width of the form element (pixel or %)

Returns:

width

setHeight

public void setHeight(java.lang.String height)

Sets the height of the form element (pixel or %)

Parameters:

height - The Height

getHeight

public java.lang.String getHeight()

Returns the height of the form element (pixel or %)

Returns:

height

setAlignment

public void setAlignment(AlignmentType alignment)

Specifies the horizontal alignment of the form element within the form

• left
• right
• center

Parameters:

alignment - The alignment of the element

getAlignment

public AlignmentType getAlignment()

Returns the horizontal alignment

Returns:

alignment

setVAlignment

public void setVAlignment(AlignmentType valignment)

Specifies the vertical alignment of the form element within the form

• top
• bottom
• center

Parameters:

valignment - The alignment of the element

getVAlignment

public AlignmentType getVAlignment()

Returns the vertical alignment

Returns:

alignment

setStyle

public void setStyle(java.lang.String style)

Sets the Style

Parameters:

style - HTML 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 form 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 form element 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