com.cc.framework.taglib.forms
Class MessageTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.cc.framework.taglib.ScriptTagSupport
          com.cc.framework.taglib.controls.BaseControlTag
              com.cc.framework.taglib.forms.MessageTag

All Implemented Interfaces:

AjaxSupportTag, DesignRuleContainerTag, FrameContainerTag, ImageContainerTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, ScriptSupport, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class MessageTag

extends BaseControlTag

implements FrameContainerTag

Tag-Handler for the message Tag.

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.28 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID Serial Version UID

Fields inherited from class com.cc.framework.taglib.controls.BaseControlTag

log

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

id, pageContext

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

MessageTag()
Constructor

Method Summary

void	addInnerFrame(InnerFrame frame) Adds a new inner Frame to the container
protected Control	doCreateControl() Creates the control element
protected ControlDesignModel	doCreateDesignModel() This method is called to create the DesignModel for the control
protected MessageDesignModel	getMessageDesignModel() Returns a casted version of the ControlDesignModel
void	setCaption(java.lang.String caption) The main title of the form.
void	setDetail(java.lang.String detail) The detail title of the form.
void	setFilter(java.lang.String filter) The automatic HTML coding of the text element can be activated or disabled with the filter-attribute
void	setFormid(java.lang.String formid) The unique identification of the form.
void	setHideButtons(java.lang.String controlButtonList) Hides all buttons in the ControlButton List.
void	setImage(ImageModel image) Sets the image
void	setPageContext(javax.servlet.jsp.PageContext pc)
void	setSeverity(java.lang.String severity) Specifies the error class of the message form.

Methods inherited from class com.cc.framework.taglib.controls.BaseControlTag

addDesignRule, beginPaint, createControl, createPainter, doEndTag, doStartTag, endPaint, getClientHandler, getControl, getDefaultAction, getDesignModel, getDirectValue, getHttpScope, getPainterContext, lookupBean, release, releaseDesignModel, setAction, setAjax, setAjax, setBorder, setDirectValue, setDisabled, setFormElement, setHeight, setHelp, setId, setLocale, setName, setPermission, setProperty, setRunat, setScope, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabindex, setTooltip, setTransaction, setValue, setWidth

Methods inherited from class com.cc.framework.taglib.ScriptTagSupport

setOnabort, setOnactivate, setOnafterprint, setOnafterupdate, setOnbeforeactivate, setOnbeforecopy, setOnbeforecut, setOnbeforedeactivate, setOnbeforeeditfocus, setOnbeforepaste, setOnbeforeprint, setOnbeforeunload, setOnbeforeupdate, setOnblur, setOnbounce, setOncellchange, setOnchange, setOncheck, setOncheckall, setOnclick, setOncollapse, setOncontextmenu, setOncontrolselect, setOncopy, setOncut, setOndataavailable, setOndatasetchanged, setOndatasetcomplete, setOndblclick, setOndeactivate, setOndrag, setOndragend, setOndragenter, setOndragleave, setOndragover, setOndragstart, setOndrop, setOnerror, setOnerrorupdate, setOnexpand, setOnexpandex, setOnfilterchange, setOnfinish, setOnfocus, setOnfocusin, setOnfocusout, setOnhelp, setOnkeydown, setOnkeypress, setOnkeyup, setOnlayoutcomplete, setOnload, setOnlosecapture, setOnmousedown, setOnmouseenter, setOnmouseleave, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnmousewheel, setOnmove, setOnmoveend, setOnmovestart, setOnpaste, setOnpropertychange, setOnreadystatechange, setOnreset, setOnresize, setOnresizeend, setOnresizestart, setOnrowenter, setOnrowexit, setOnrowsdelete, setOnrowsinserted, setOnscroll, setOnselect, setOnselectionchange, setOnselectstart, setOnspindown, setOnspinup, setOnstart, setOnstop, setOnsubmit, setOnuncheck, setOnuncheckall, setOnunload

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

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

Constructor Detail

MessageTag

public MessageTag()

Constructor

Method Detail

doCreateDesignModel

protected ControlDesignModel doCreateDesignModel()

Description copied from class: BaseControlTag

This method is called to create the DesignModel for the control

Specified by:

doCreateDesignModel in class BaseControlTag

Returns:

A concrete DesignModel

See Also:

BaseControlTag.doCreateDesignModel()

getMessageDesignModel

protected MessageDesignModel getMessageDesignModel()

Returns a casted version of the ControlDesignModel

Returns:

MessageDesignModel

setPageContext

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

Specified by:

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

Overrides:

setPageContext in class BaseControlTag

See Also:

Tag.setPageContext(PageContext pc)

doCreateControl

protected Control doCreateControl()
                           throws javax.servlet.jsp.JspException

Description copied from class: BaseControlTag

Creates the control element

Specified by:

doCreateControl in class BaseControlTag

Returns:

control element

Throws:

javax.servlet.jsp.JspException - If an error during bean lookup occurs

See Also:

BaseControlTag.doCreateControl()

setCaption

public void setCaption(java.lang.String caption)

The main title of the form. The title and detail can also be specified together in the form "title - detail.

Parameters:

caption - The caption

setDetail

public void setDetail(java.lang.String detail)

The detail title of the form.

Parameters:

detail - The detail title

setSeverity

public void setSeverity(java.lang.String severity)
                 throws javax.servlet.jsp.JspException

Specifies the error class of the message form. The appearance of the form is influenced by the error class.

• none = no errors
• information = Information
• warning = Warning
• error = error
• fatal = fatal error. In case of a fatal error the application cannot continue running.

Parameters:

severity - Severity

Throws:

javax.servlet.jsp.JspException - if the argument can not be converted to an Object of Type Severity

setFormid

public void setFormid(java.lang.String formid)

The unique identification of the form. It is written in the form as a hidden field with the name formid and is thus available at the time of a form submission. The framework can call the corresponding EventHandler via the formid.

Parameters:

formid - Id of the Form

setFilter

public void setFilter(java.lang.String filter)
               throws javax.servlet.jsp.JspException

The automatic HTML coding of the text element can be activated or disabled with the filter-attribute

Parameters:

filter - true if the text should be HTML encoded.

Throws:

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

addInnerFrame

public void addInnerFrame(InnerFrame frame)

Description copied from interface: FrameContainerTag

Adds a new inner Frame to the container

Specified by:

addInnerFrame in interface FrameContainerTag

Parameters:

frame - The inner Frame to add

See Also:

FrameContainerTag.addInnerFrame(com.cc.framework.ui.model.InnerFrame)

setImage

public void setImage(ImageModel image)

Description copied from interface: ImageContainerTag

Sets the image

Specified by:

setImage in interface ImageContainerTag

Parameters:

image - The image model for the image

See Also:

ImageContainerTag.setImage(com.cc.framework.ui.model.ImageModel)

setHideButtons

public void setHideButtons(java.lang.String controlButtonList)
                    throws javax.servlet.jsp.JspException

Hides all buttons in the ControlButton List.

Parameters:

controlButtonList - A semicolon delimited list of ControlButton names

Throws:

javax.servlet.jsp.JspException - Is thrown when a invalid ControlButton Name is specified