com.cc.framework.ui.painter.def
Class DefMessagePainter

java.lang.Object
  com.cc.framework.ui.painter.ControlPainter
      com.cc.framework.ui.painter.def.DefPainterBase
          com.cc.framework.ui.painter.def.DefMessagePainter

Direct Known Subclasses:

DefMessageErrorPainter, DefMessageInfoPainter, DefMessageSeverityPainter, DefMessageWarningPainter

public abstract class DefMessagePainter

extends DefPainterBase

Base class for the message controls

Since:

1.0

Version:

$Revision: 1.29 $

Author:

Gernot Schulz

Field Summary

static java.lang.String[]

IMAGES Images for the different severities

Fields inherited from class com.cc.framework.ui.painter.ControlPainter

log

Constructor Summary

DefMessagePainter(PainterContext painterContext, MessageControl ctrl)
Constructor

Method Summary

protected org.apache.ecs.ConcreteElement	addMessage(Message message) Adds a single Message
protected org.apache.ecs.html.IMG	createSeverityImg(Message message) Returns a severity image for the given message
protected org.apache.ecs.ConcreteElement	doCreateBody() Template method that gets called when the body of the control should be rendered.
protected org.apache.ecs.ConcreteElement	doCreateElement() Creates the HTML-Element.
protected org.apache.ecs.ConcreteElement	doCreateFooter() Creates an additional footer.
protected org.apache.ecs.ConcreteElement	doCreateHeader() Creates an additional header.
protected java.util.Collection	doCreateTitleButtons() Creates the buttons in the header of the list
protected MessageControl	getCtrl() Retrieves the control for this painter
protected FrameTitle	getFrameTitle() Creates the Title for the Frame
protected Message[]	getMessages() Returns a list of messages that is filtered to the controls severity

Methods inherited from class com.cc.framework.ui.painter.def.DefPainterBase

createHelpElement, createHelpElement, doCreateHelpButton, doCreateHelpIcon, getElementClass

Methods inherited from class com.cc.framework.ui.painter.ControlPainter

ajaxPaint, attr, attr, attr, beginPaint, createActionPainter, createActionPainter, createElement, createImage, createImage, createImage, createInput, createInput, createSpacer, createSpacer, createSpacer, decorateURL, doAddDecorationsToRow, doAddDecorationsToRow, doAfterCreate, doAttachDecorations, doBeforeCreate, encodeURL, endPaint, forceControlName, getAsString, getAwtColor, getColor, getContextPath, getControlName, getDecorationsOnce, getElementName, getFramePainter, getFrameworkString, getFrameworkString, getImage, getImage, getImage, getImageSrc, getImageSrc, getImageSrc, getLocale, getPageContext, getPainterContext, getPrincipal, getRequest, getResponse, getSession, getSmartCaption, getSmartDetail, getSource, getSource, getStringResource, getStyleId, html, html, html, init, isRunAtClient, localize, localize, localize, paint, removeHtml, removeHtml, request, response, session, showComments

Methods inherited from class java.lang.Object

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

Field Detail

IMAGES

public static final java.lang.String[] IMAGES

Images for the different severities

Constructor Detail

DefMessagePainter

public DefMessagePainter(PainterContext painterContext,
                         MessageControl ctrl)

Constructor

Parameters:

painterContext - The PainterContext

ctrl - The Control to render

Method Detail

getCtrl

protected MessageControl getCtrl()

Retrieves the control for this painter

Returns:

Control

getMessages

protected Message[] getMessages()

Returns a list of messages that is filtered to the controls severity

Returns:

Filtered Message List

createSeverityImg

protected org.apache.ecs.html.IMG createSeverityImg(Message message)

Returns a severity image for the given message

Parameters:

message - Message

Returns:

Severity Image

doCreateHeader

protected org.apache.ecs.ConcreteElement doCreateHeader()

Creates an additional header.

Returns:

ConcreteElement

doCreateBody

protected org.apache.ecs.ConcreteElement doCreateBody()

Template method that gets called when the body of the control should be rendered.

Returns:

Body HTML Elements

doCreateFooter

protected org.apache.ecs.ConcreteElement doCreateFooter()

Creates an additional footer. The current layout does not render a footer

Returns:

ConcreteElement

addMessage

protected org.apache.ecs.ConcreteElement addMessage(Message message)

Adds a single Message

Parameters:

message - The message to add

Returns:

ConcreteElement

doCreateTitleButtons

protected java.util.Collection doCreateTitleButtons()

Creates the buttons in the header of the list

Returns:

collection of ConcreteElement Items

getFrameTitle

protected FrameTitle getFrameTitle()

Creates the Title for the Frame

Returns:

Frame Title or null

doCreateElement

protected org.apache.ecs.ConcreteElement doCreateElement()

Description copied from class: ControlPainter

Creates the HTML-Element. This Method must be implemented by the concrete Sub-Class

Specified by:

doCreateElement in class ControlPainter

Returns:

ConcreteElement

See Also:

ControlPainter.doCreateElement()