e4s.html
Class E4Message

java.lang.Object
  e4s.util.E4Object
      e4s.html.E4HtmlObject
          e4s.html.E4HtmlElementGeneral
              e4s.html.E4Message

All Implemented Interfaces:

E4HtmlElement_Intf

public class E4Message
extends E4HtmlElementGeneral
implements E4HtmlElement_Intf

Display a message (text surrounded by a box).

Since:

JDK 1.4

Example_BoxRoundCorners.java

See Also:

e4s.html.E4HtmlContentElement#E4Message(int,String), e4s.html.E4HtmlContentElement#E4Message(int,e4s.translate.E4Label_Intf), E4Box, e4s.html.BoxRc

Field Summary

static int	CAPTION Display a box, without any image.
static int	ERROR Display a box, use a "stop-sign" image.
static int	INFO Display a box, use a "info-sign" image.
static E4Color	m_E4Color_CAPTION
static E4Color	m_E4Color_ERROR
static E4Color	m_E4Color_INFO
static E4Color	m_E4Color_PERMISSION
static E4Color	m_E4Color_QUESTION
static E4Color	m_E4Color_WAIT
static E4Color	m_E4Color_WARNING
static int	PERMISSION Display a box, use a "restricted" image.
static int	QUESTION Display a box, use a "questionmark-sign" image.
static int	WAIT Display a hour-glass symbol image.
static int	WARNING Display a box, use a "i-sign" image.

Fields inherited from class e4s.html.E4HtmlElementGeneral

m_elements, m_needed_scripts

Fields inherited from class e4s.html.E4HtmlObject

m_parent_e4sID

Fields inherited from class e4s.util.E4Object

CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET

Constructor Summary

E4Message(E4Label_Intf msg)
Construct a message, use the CAPTION mode for display.

E4Message(int state, E4Label_Intf msg)
Construct a message, use the CAPTION mode for display.

E4Message(int state, java.lang.String msg)
Construct a message, use the CAPTION mode for display.

E4Message(java.lang.String msg)
Construct a message, use the CAPTION mode for display.

Method Summary

static java.lang.String	_getSVNVersionString()
void	collectStylesForEditing(E4StylesHash v, E4ServletImplementation_Intf servlet) Build a list (Vector) with style definitions used so far during display of this page.
void	collectTranslationsForEditing(E4TranslationsVec v, E4ServletImplementation_Intf servlet) Build a list (Vector) with translation texts used so far during display of this page.
static void	setColor_CAPTION(E4Color color) Set the default color for E4Messages of style QUESTION.
static void	setColor_ERROR(E4Color color) Set the default color for E4Messages of style ERROR.
static void	setColor_INFO(E4Color color) Set the default color for E4Messages of style INFO.
static void	setColor_QUESTION(E4Color color) Set the default color for E4Messages of style QUESTION.
static void	setColor_WARNING(E4Color color) Set the default color for E4Messages of style WARNING.
static void	setDefaultSTYLE(CLASS_Name classname_box, CLASS_Name classname_content) Set the E4CSS Style for all message (static), valid unless you overwrite the style for a particular message using setSTYLE(e4s.html.style.CLASS_Name, e4s.html.style.CLASS_Name)).
void	setSTYLE_Box(CLASS_Name classname_box) Set the E4CSS Style for this particular message (surrounding box only).
void	setSTYLE(CLASS_Name classname_content) Set the E4CSS Style for this particular message (inner content table only).
void	setSTYLE(CLASS_Name classname_box, CLASS_Name classname_content) Set the E4CSS Style for this particular message.
void	toHtml(E4StringBufferHtml buf, E4ServletImplementation_Intf servlet) Create the HTML output for this element.
void	useAbsolutePathForImages(boolean mode)

Methods inherited from class e4s.html.E4HtmlElementGeneral

addScript, addScript, addScript, addStyleForEditing, addTranslationForEditing, buildStyleAttribute, buildStyleClassReference, collectScripts, collectStylesForEditing, collectStylesForEditing, collectTranslationsForEditing, createScript, createScript, debugToString, findElement, findElement, findElement, findElement, getElements, getElementsVec, getField, getId, getLastElement, getStringContent, getStyle, getSTYLE, getStyle, hasScripts, hasSTYLE, isContentClass, isE4InputField_Intf, openTag, removeAll, removeElementById, removeElements, removeElements, removeStyle, setId, setReadOnly, setStyle, setStyle, setSTYLE, setValue, Style, Style, toHtml_hidden, validate

Methods inherited from class e4s.html.E4HtmlObject

E4ID, E4ID, set_e4sID

Methods inherited from class e4s.util.E4Object

Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, toString, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait

Methods inherited from class java.lang.Object

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

Methods inherited from interface e4s.html.E4HtmlElement_Intf

addScript, addScript, addScript, collectScripts, debugToString, findElement, findElement, getElements, getElementsVec, getField, getId, getStringContent, isContentClass, removeAll, removeElementById, removeElements, set_e4sID, setId, setReadOnly, setValue, toHtml_hidden, validate

Field Detail

CAPTION

public static final int CAPTION

Display a box, without any image.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Display a box, use a "stop-sign" image.

See Also:

E4Images.msg_error, Constant Field Values

WARNING

public static final int WARNING

Display a box, use a "i-sign" image.

See Also:

E4Images.msg_warning, Constant Field Values

INFO

public static final int INFO

Display a box, use a "info-sign" image.

See Also:

E4Images.msg_info, Constant Field Values

PERMISSION

public static final int PERMISSION

Display a box, use a "restricted" image.

See Also:

E4Images.msg_question, Constant Field Values

QUESTION

public static final int QUESTION

Display a box, use a "questionmark-sign" image.

See Also:

E4Images.msg_question, Constant Field Values

WAIT

public static final int WAIT

Display a hour-glass symbol image.

See Also:

E4Images.msg_wait, Constant Field Values

m_E4Color_ERROR

public static E4Color m_E4Color_ERROR

m_E4Color_PERMISSION

public static E4Color m_E4Color_PERMISSION

m_E4Color_WARNING

public static E4Color m_E4Color_WARNING

m_E4Color_INFO

public static E4Color m_E4Color_INFO

m_E4Color_WAIT

public static E4Color m_E4Color_WAIT

m_E4Color_QUESTION

public static E4Color m_E4Color_QUESTION

m_E4Color_CAPTION

public static E4Color m_E4Color_CAPTION

Constructor Detail

E4Message

public E4Message(java.lang.String msg)

Construct a message, use the CAPTION mode for display.

Parameters:

msg - the message to be displayed

E4Message

public E4Message(E4Label_Intf msg)

Construct a message, use the CAPTION mode for display.

Parameters:

msg - the message to be displayed

E4Message

public E4Message(int state,
                 java.lang.String msg)

Construct a message, use the CAPTION mode for display.

Parameters:

state - the display-state for this message (CAPTION which is the default, ERROR, INFO).

msg - the message to be displayed

E4Message

public E4Message(int state,
                 E4Label_Intf msg)

Construct a message, use the CAPTION mode for display.

Parameters:

state - the display-state for this message (CAPTION which is the default, ERROR, INFO).

msg - the message to be displayed

Method Detail

setSTYLE

public void setSTYLE(CLASS_Name classname_box,
                     CLASS_Name classname_content)

Set the E4CSS Style for this particular message.

Parameters:

classname_box - the name of a E4CSS class for the surrounding box

classname_content - the name of a E4CSS class for the content table

setSTYLE_Box

public void setSTYLE_Box(CLASS_Name classname_box)

Set the E4CSS Style for this particular message (surrounding box only).

Parameters:

classname_box - the name of a E4CSS class for the surrounding box

setSTYLE

public void setSTYLE(CLASS_Name classname_content)

Set the E4CSS Style for this particular message (inner content table only).

Parameters:

classname_content - the name of a E4CSS class for the content table

setDefaultSTYLE

public static void setDefaultSTYLE(CLASS_Name classname_box,
                                   CLASS_Name classname_content)

Set the E4CSS Style for all message (static), valid unless you overwrite the style for a particular message using setSTYLE(e4s.html.style.CLASS_Name, e4s.html.style.CLASS_Name)).

Parameters:

classname_box - the name of a E4CSS class for the surrounding box

classname_content - the name of a E4CSS class for the inner text

toHtml

public void toHtml(E4StringBufferHtml buf,
                   E4ServletImplementation_Intf servlet)
            throws java.lang.Exception

Description copied from interface: E4HtmlElement_Intf

Create the HTML output for this element. Also run throught all child elements, and call their E4HtmlElement_Intf.toHtml(e4s.util.E4StringBufferHtml, e4s.servlet.E4ServletImplementation_Intf) function to generate output of those objects which becomes appended. Normally, there is no need to call this function anyway, and this also might result in side effects of too-early relasing of objects in some cases. This function is called by E4ServletImplementation_Intf.write(e4s.html.E4HtmlElement) on the top level HTML element (common this is a HTML or BODY element) and branches down to all child elements.

Specified by:

toHtml in interface E4HtmlElement_Intf

Overrides:

toHtml in class E4HtmlElementGeneral

servlet - the servlet environment currently running in

Throws:

java.lang.Exception

collectTranslationsForEditing

public void collectTranslationsForEditing(E4TranslationsVec v,
                                          E4ServletImplementation_Intf servlet)

Description copied from class: E4HtmlElementGeneral

Build a list (Vector) with translation texts used so far during display of this page. Run throught all subclasses elements and collect their texts as well. Note, that a text will only be added one time. The Vector contains elements of class E4Label.

Specified by:

collectTranslationsForEditing in interface E4HtmlElement_Intf

Overrides:

collectTranslationsForEditing in class E4HtmlElementGeneral

Parameters:

v - the Vector where the styles will be collected, may not be null

servlet - the current servlet instance

See Also:

E4Label_Intf

collectStylesForEditing

public void collectStylesForEditing(E4StylesHash v,
                                    E4ServletImplementation_Intf servlet)

Build a list (Vector) with style definitions used so far during display of this page. Run throught all subclasses elements and collect their styles as well. Note, that a style will only be added one time. The Vector contains elements of class E4StyleUsage.

Specified by:

collectStylesForEditing in interface E4HtmlElement_Intf

Overrides:

collectStylesForEditing in class E4HtmlElementGeneral

Parameters:

v - the Vector where the styles will be collected, may not be null

servlet - the servlet context

See Also:

E4ServletImplementation_Intf.sessionCanEditStyles(), #collectStylesForEditing(e4s.html.style.E4StylesHash, e4s.html.style.STYLE_Name, boolean)

setColor_ERROR

public static void setColor_ERROR(E4Color color)

Set the default color for E4Messages of style ERROR.

Parameters:

color - the color to be used

See Also:

ERROR, setColor_INFO(e4s.html.E4Color), setColor_WARNING(e4s.html.E4Color), setColor_QUESTION(e4s.html.E4Color)

setColor_WARNING

public static void setColor_WARNING(E4Color color)

Set the default color for E4Messages of style WARNING.

Parameters:

color - the color to be used

See Also:

WARNING, setColor_ERROR(e4s.html.E4Color), setColor_INFO(e4s.html.E4Color), setColor_QUESTION(e4s.html.E4Color), setColor_CAPTION(e4s.html.E4Color)

setColor_INFO

public static void setColor_INFO(E4Color color)

Set the default color for E4Messages of style INFO.

Parameters:

color - the color to be used

See Also:

INFO, setColor_ERROR(e4s.html.E4Color), setColor_WARNING(e4s.html.E4Color), setColor_QUESTION(e4s.html.E4Color), setColor_CAPTION(e4s.html.E4Color)

setColor_QUESTION

public static void setColor_QUESTION(E4Color color)

Set the default color for E4Messages of style QUESTION.

Parameters:

color - the color to be used

See Also:

QUESTION, setColor_ERROR(e4s.html.E4Color), setColor_INFO(e4s.html.E4Color), setColor_WARNING(e4s.html.E4Color), setColor_CAPTION(e4s.html.E4Color)

setColor_CAPTION

public static void setColor_CAPTION(E4Color color)

Set the default color for E4Messages of style QUESTION.

Parameters:

color - the color to be used

See Also:

CAPTION, setColor_ERROR(e4s.html.E4Color), setColor_INFO(e4s.html.E4Color), setColor_WARNING(e4s.html.E4Color), setColor_QUESTION(e4s.html.E4Color)

useAbsolutePathForImages

public void useAbsolutePathForImages(boolean mode)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()