com.cc.framework.taglib.forms
Class FormElementGroupTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      javax.servlet.jsp.tagext.BodyTagSupport
          com.cc.framework.taglib.forms.FormElementGroupTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, FormElementContainerTag, FormElementTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

FormButtonSectionTag, FormElementRowTag, FormElementSectionTag

public class FormElementGroupTag

extends javax.servlet.jsp.tagext.BodyTagSupport

implements FormElementContainerTag, InnerTag

Tag-Handler for the group Tag.

Version:

$Revision: 1.20 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private FormGroupElement	group Designmodel
private static long	serialVersionUID Serial Version UID

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

FormElementGroupTag()
Constructor

Method Summary

void	addColumn(FormColumn column) Adds a column definition to the container
void	addFormElement(FormElement element) Adds a control to the container
int	doAfterBody()
protected FormGroupElement	doCreateGroup() Creates the Group element
int	doEndTag()
int	doStartTag()
protected FormGroupElement	getGroup() Returns the Group Element
void	release()
protected void	releaseGroup() Release the current group
void	setAlign(java.lang.String alignment) Specifies the horizontal alignment of the form element within the form left right center
void	setCellWidth(java.lang.String width) Sets the width of the control cells for this container.
void	setColspan(java.lang.String colspan) Sets the column span of this form element
void	setExpandProperty(java.lang.String propertyName) Sets the name of a property that is used to expand or collapse the group
void	setHeight(java.lang.String height) Sets the height of the form element (pixel or %)
void	setHelp(java.lang.String helpId) Associates this control with a help id
void	setJoin(java.lang.String join) This method specifies that two adjacent form elements should be joined together without a separator
void	setLabelWidth(java.lang.String width) Sets the width of the labels for this container.
void	setNoframe(java.lang.String noframe) Disables the groups border
void	setOrientation(java.lang.String orientation) Specifies the orientation of the elements in the group: horizontal = from top to bottom vertical = from left to right
void	setPageContext(javax.servlet.jsp.PageContext pc)
void	setPermission(java.lang.String permission) Sets the permission for the element
void	setStyle(java.lang.String style) An HTML-style.
void	setStyleClass(java.lang.String styleClass) The HTML-class attribute.
void	setStyleId(java.lang.String styleId) The HTML-id attribute.
void	setValign(java.lang.String alignment) 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 class javax.servlet.jsp.tagext.BodyTagSupport

doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setParent

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

group

private FormGroupElement group

Designmodel

Constructor Detail

FormElementGroupTag

public FormElementGroupTag()

Constructor

Method Detail

getGroup

protected FormGroupElement getGroup()

Returns the Group Element

Returns:

Group

doCreateGroup

protected FormGroupElement doCreateGroup()

Creates the Group element

Returns:

Group Element

releaseGroup

protected void releaseGroup()

Release the current group

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pc)

Specified by:

setPageContext in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.setPageContext(PageContext pc)

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

See Also:

Tag.release()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doStartTag()

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Throws:

javax.servlet.jsp.JspException

See Also:

IterationTag.doAfterBody()

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Throws:

javax.servlet.jsp.JspException

See Also:

Tag.doEndTag()

addColumn

public void addColumn(FormColumn column)

Description copied from interface: FormElementContainerTag

Adds a column definition to the container

Specified by:

addColumn in interface FormElementContainerTag

Parameters:

column - column definition

See Also:

FormElementContainerTag.addColumn(com.cc.framework.ui.model.FormColumn)

addFormElement

public void addFormElement(FormElement element)

Description copied from interface: FormElementContainerTag

Adds a control to the container

Specified by:

addFormElement in interface FormElementContainerTag

Parameters:

element - FormElement

See Also:

FormElementContainerTag.addFormElement(FormElement)

setPermission

public void setPermission(java.lang.String permission)
                   throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Sets the permission for the element

Specified by:

setPermission in interface FormElementTag

Parameters:

permission - Permission

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to Permission

See Also:

FormElementTag.setPermission(java.lang.String)

setOrientation

public void setOrientation(java.lang.String orientation)
                    throws javax.servlet.jsp.JspException

Specifies the orientation of the elements in the group:

• horizontal = from top to bottom
• vertical = from left to right

Parameters:

orientation - The orientation of the column

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an OrientationType

setColspan

public void setColspan(java.lang.String colspan)
                throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Sets the column span of this form element

Specified by:

setColspan in interface FormElementTag

Parameters:

colspan - column span

Throws:

javax.servlet.jsp.JspException - Is thrown when a number conversion error occurs

See Also:

FormElementTag.setColspan(java.lang.String)

setJoin

public void setJoin(java.lang.String join)
             throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

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

Specified by:

setJoin in interface FormElementTag

Parameters:

join - true when the form elements should be joined

Throws:

javax.servlet.jsp.JspException - if the Argument can not be converted to a boolean Value

See Also:

FormElementTag.setJoin(java.lang.String)

setAlign

public void setAlign(java.lang.String alignment)
              throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Specifies the horizontal alignment of the form element within the form

• left
• right
• center

Specified by:

setAlign in interface FormElementTag

Parameters:

alignment - The alignment of the element

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an AlignmentType

See Also:

FormElementTag.setAlign(java.lang.String)

setValign

public void setValign(java.lang.String alignment)
               throws javax.servlet.jsp.JspException

Description copied from interface: FormElementTag

Specifies the vertical alignment of the form element within the form

• top
• bottom
• center

Specified by:

setValign in interface FormElementTag

Parameters:

alignment - The alignment of the element

Throws:

javax.servlet.jsp.JspException - If the argument can't be converted to an AlignmentType

See Also:

FormElementTag.setValign(java.lang.String)

setHeight

public void setHeight(java.lang.String height)

Description copied from interface: FormElementTag

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

Specified by:

setHeight in interface FormElementTag

Parameters:

height - The Height

See Also:

FormElementTag.setHeight(java.lang.String)

setWidth

public void setWidth(java.lang.String width)

Description copied from interface: FormElementTag

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

Specified by:

setWidth in interface FormElementTag

Parameters:

width - The Width

See Also:

FormElementTag.setWidth(java.lang.String)

setStyle

public void setStyle(java.lang.String style)

Description copied from interface: FormElementTag

An HTML-style. See HTML documentation for the attribute style.

Specified by:

setStyle in interface FormElementTag

Parameters:

style - An HTML-style

See Also:

FormElementTag.setStyle(java.lang.String)

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description copied from interface: FormElementTag

The HTML-class attribute. See HTML documentation for the attribute class.

Specified by:

setStyleClass in interface FormElementTag

Parameters:

styleClass - The HTML-class attribute

See Also:

FormElementTag.setStyleClass(java.lang.String)

setStyleId

public void setStyleId(java.lang.String styleId)

Description copied from interface: FormElementTag

The HTML-id attribute. See HTML documentation for the Attribute id.

Specified by:

setStyleId in interface FormElementTag

Parameters:

styleId - The HTML-id attribute

See Also:

FormElementTag.setStyleId(java.lang.String)

setHelp

public void setHelp(java.lang.String helpId)

Description copied from interface: FormElementTag

Associates this control with a help id

Specified by:

setHelp in interface FormElementTag

Parameters:

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

See Also:

FormElementTag.setHelp(java.lang.String)

setNoframe

public void setNoframe(java.lang.String noframe)
                throws javax.servlet.jsp.JspException

Description copied from interface: FormElementContainerTag

Disables the groups border

Specified by:

setNoframe in interface FormElementContainerTag

Parameters:

noframe - true if the groups frame should be hidden

Throws:

javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

See Also:

FormElementContainerTag.setNoframe(java.lang.String)

setExpandProperty

public void setExpandProperty(java.lang.String propertyName)

Description copied from interface: FormElementContainerTag

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

Specified by:

setExpandProperty in interface FormElementContainerTag

Parameters:

propertyName - java property name

See Also:

FormElementContainerTag.setExpandProperty(java.lang.String)

setLabelWidth

public void setLabelWidth(java.lang.String width)

Description copied from interface: FormElementContainerTag

Sets the width of the labels for this container.

Specified by:

setLabelWidth in interface FormElementContainerTag

Parameters:

width - label width

See Also:

FormElementContainerTag.setLabelWidth(java.lang.String)

setCellWidth

public void setCellWidth(java.lang.String width)

Description copied from interface: FormElementContainerTag

Sets the width of the control cells for this container.

Specified by:

setCellWidth in interface FormElementContainerTag

Parameters:

width - control cell width

See Also:

FormElementContainerTag.setCellWidth(java.lang.String)