com.cc.framework.ui.control
Interface FormElementContainer

All Superinterfaces:

AccessControlled, FormElement

All Known Subinterfaces:

FormDesignModel

All Known Implementing Classes:

FormDesignModelImp, FormGroupElement

public interface FormElementContainer

extends FormElement, AccessControlled

Container for form elements

Since:

1.0

Version:

Revision: 1.5 $

Author:

Harald Schulz

Method Summary

void	addFormElement(FormElement element) Adds a new child element to the container
java.lang.String	getCellWidth() Returns the width of the control cell for this container.
FormColumnGroup	getColumnGroup()
java.lang.String	getExpandProperty() Retrieves the name of a property that is used to expand or collapse the group
FormElement	getFormElement(int index) Returns a single elements in the container
FormElement[]	getFormElements() Returns a list with all elements in the container
FormElement[]	getFormElements(Principal principal) Returns a list with all visible elements in the container filtered on the principals permissions
java.lang.String	getLabelWidth() Returns the width of the labels for this container.
OrientationType	getOrientation()
void	removeFormElement(FormElement element) Removes the specified form element from the container
void	setCellWidth(java.lang.String width) Sets the width of the control cell for this container.
void	setExpandProperty(java.lang.String propertyName) Sets the name of a property that is used to expand or collapse the group
void	setLabelWidth(java.lang.String width) Sets the width of the labels for this container.
void	setShowFrame(boolean show) Disables the forms border
boolean	showFrame()
int	size() Returns the number of elements in the container

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

getPermission, show

Method Detail

addFormElement

public void addFormElement(FormElement element)

Adds a new child element to the container

Parameters:

element - The new form element

getExpandProperty

public java.lang.String getExpandProperty()

Retrieves the name of a property that is used to expand or collapse the group

Returns:

propertyName

getFormElement

public FormElement getFormElement(int index)

Returns a single elements in the container

Parameters:

index - Elements index

Returns:

FormElement

getFormElements

public FormElement[] getFormElements()

Returns a list with all elements in the container

Returns:

FormElement

getFormElements

public FormElement[] getFormElements(Principal principal)

Returns a list with all visible elements in the container filtered on the principals permissions

Parameters:

principal - the principal object with the permissions

Returns:

FormElement

getOrientation

public OrientationType getOrientation()

Returns:

the orientation of the child elements

removeFormElement

public void removeFormElement(FormElement element)

Removes the specified form element from the container

Parameters:

element - The form element to remove

setExpandProperty

public void setExpandProperty(java.lang.String propertyName)

Sets the name of a property that is used to expand or collapse the group

Parameters:

propertyName - java property name

setShowFrame

public void setShowFrame(boolean show)

Disables the forms border

Parameters:

show - true if the forms frame should be shown

showFrame

public boolean showFrame()

Returns:

true if the frame should be shown

size

public int size()

Returns the number of elements in the container

Returns:

integer

getLabelWidth

public java.lang.String getLabelWidth()

Returns the width of the labels for this container.

Returns:

label width or null for default label width

setLabelWidth

public void setLabelWidth(java.lang.String width)

Sets the width of the labels for this container.

Parameters:

width - label width or null for default label width

getCellWidth

public java.lang.String getCellWidth()

Returns the width of the control cell for this container.

Returns:

control cell width or null

setCellWidth

public void setCellWidth(java.lang.String width)

Sets the width of the control cell for this container.

Parameters:

width - control cell width or null

getColumnGroup

public FormColumnGroup getColumnGroup()

Returns:

returns the column group for this element group