com.cc.framework.taglib.forms
Class FormElementMessageTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended bycom.cc.framework.taglib.forms.FormElementMessageTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, FormElementTag, InnerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class FormElementMessageTag
extends javax.servlet.jsp.tagext.BodyTagSupport
implements FormElementTag, InnerTag

Tag-Handler for the Message Formelement.

Generates a message text form. The form expects, as the data model, an implementation of the interface com.cc.framework.message.Message.MessageDataModel. Struts: If the Struts Framework is being used, the tag can also be used without the specification of a Data Bean. In this case, the Struts error collection (severity="error") or the message collection (severity="information") are displayed.

Since:
1.0
Version:
$Revision: 1.27 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  FormMessageElement formElement
          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
FormElementMessageTag()
          Constructor
 
Method Summary
 int doAfterBody()
           
 FormMessageElement doCreateFormMessageElement()
          Creates the form element
 int doEndTag()
           
 FormMessageElement getFormMessageElement()
          Returns the concrete form element
 void release()
           
protected  void releaseFormElement()
          Release the current form element
 void setAlign(java.lang.String alignment)
          Specifies the horizontal alignment of the form element within the form left right center
 void setColspan(java.lang.String colspan)
          Sets the column span of this form element
 void setFilter(java.lang.String filter)
          The automatic HTML coding of the element can be activated or disabled with the filter-attribute.
 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 setMessage(java.lang.String message)
          Sets the Message
 void setPageContext(javax.servlet.jsp.PageContext pc)
           
 void setPermission(java.lang.String permission)
          Sets the permission for the element
 void setSeverity(java.lang.String severity)
          Sets the severity of the message.
 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, doStartTag, 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

formElement

private FormMessageElement formElement
Designmodel

Constructor Detail

FormElementMessageTag

public FormElementMessageTag()
Constructor

Method Detail

getFormMessageElement

public FormMessageElement getFormMessageElement()
Returns the concrete form element

Returns:
form element

doCreateFormMessageElement

public FormMessageElement doCreateFormMessageElement()
Creates the form element

Returns:
form element

releaseFormElement

protected void releaseFormElement()
Release the current form element


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()

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()

setMessage

public void setMessage(java.lang.String message)
Sets the Message

Parameters:
message - Message

setSeverity

public void setSeverity(java.lang.String severity)
                 throws javax.servlet.jsp.JspException
Sets the severity of the message.

Parameters:
severity - The severity to set
Throws:
javax.servlet.jsp.JspException - if the argument can not be converted to an Object of Type Severity

setFilter

public void setFilter(java.lang.String filter)
               throws javax.servlet.jsp.JspException
The automatic HTML coding of the element can be activated or disabled with the filter-attribute. The default is true

Parameters:
filter - true if the element should be HTML encoded.
Throws:
javax.servlet.jsp.JspException - If the Argument can't be converted to boolean

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)

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

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

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 final 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)


Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.