to.etc.domui.component.misc

Class MessageFlare

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Div

to.etc.domui.component.misc.Flare

to.etc.domui.component.misc.MessageFlare

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IDraggable, IDropBody, IDropTargetable

public class MessageFlare
extends Flare

Message flare component. Shows message flare on screen. If defined as auto vanish, message disappears automatically, otherwise it disappears on any user mouse move.

Author:

Frits Jalvingh, Vladimir Mijic Created on 2 Sep 2011

Constructor Summary

Constructors

Constructor and Description
MessageFlare() Create message flare of MsgType.ERROR type.
MessageFlare(MsgType type) Create message flare.
MessageFlare(MsgType type, boolean autoVanish) Create message flare.

Method Summary

Modifier and Type	Method and Description
void	addMessage(String message) Adds message to message flare.
void	addMessage(String message, MsgType type) Adds message to message flare.
void	addMessage(UIMessage uim) Add a UIMessage to the flare.
void	createContent()
static MessageFlare	display(NodeContainer parent, MsgType type, String message) Display flare message.
static MessageFlare	display(NodeContainer parent, String message) Display flare message.
static MessageFlare	display(NodeContainer parent, UIMessage message) Display flare message.
void	setType(MsgType type) Set flare type.

Methods inherited from class to.etc.domui.component.misc.Flare

addJavascript, get, isAutoVanish, setAutoVanish

Methods inherited from class to.etc.domui.dom.html.Div

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebDataRequest, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MessageFlare

public MessageFlare()

Create message flare of MsgType.ERROR type. Message would stay on screen until any user mouse move. To make it autoVanish or of other type, use MessageFlare(MsgType, boolean)

MessageFlare

public MessageFlare(MsgType type)

Create message flare. Message would stay on screen until any user mouse move. To make it autoVanish use MessageFlare(MsgType, boolean)

Parameters:

type - Type of message. See MsgType.

MessageFlare

public MessageFlare(MsgType type,
                    boolean autoVanish)

Create message flare.

Parameters:

type - Type of message. See MsgType.

stay - If T, message would stay on screen until any user mouse move. See Flare.setAutoVanish(boolean)

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class Flare

Throws:

Exception

addMessage

public void addMessage(String message)

Adds message to message flare.

Parameters:

message - new message

addMessage

public void addMessage(@Nonnull
                       String message,
                       @Nonnull
                       MsgType type)

Adds message to message flare. If multiple messages are added, the "severest" type will be added.

Parameters:

message - new message

type - flare type

addMessage

public void addMessage(UIMessage uim)

Add a UIMessage to the flare. If multiple messages are added, the "severest" type will be added.

Parameters:

uim -

setType

public void setType(MsgType type)

Set flare type. See MsgType.

Parameters:

type -

display

public static MessageFlare display(NodeContainer parent,
                                   String message)

Display flare message.

Parameters:

parent -

message -

Returns:

created MessageFlare instance.

display

public static MessageFlare display(NodeContainer parent,
                                   MsgType type,
                                   String message)

Display flare message.

Parameters:

parent -

type - @see setType(MsgType)

message -

Returns:

created MessageFlare instance.

display

public static MessageFlare display(NodeContainer parent,
                                   UIMessage message)

Display flare message. Add localized message string and type from specified UIMessage.

Parameters:

parent -

message -

Returns:

created MessageFlare instance.