ICEfaces ACE Components 3.3.0
Java API Documentation

org.icefaces.ace.component.message
Class MessageBase

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIMessage
              extended by org.icefaces.ace.component.message.MessageBase
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IMessage
Direct Known Subclasses:
Message

public class MessageBase
extends javax.faces.component.UIMessage
implements IMessage

The message tag renders the first Faces message (if redisplay is true) or the first undisplayed Faces message (if redisplay is false) for a specific component. Styling is done by predefined jQuery classes in theme stylesheets:


Nested Class Summary
protected static class MessageBase.PropertyKeys
           
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIMessage
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
 
Constructor Summary
MessageBase()
           
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getLang()
          Return the value of the lang property.
 java.lang.String getStyle()
          Return the value of the style property.
 java.lang.String getStyleClass()
          Return the value of the styleClass property.
 java.lang.String getTitle()
          Return the value of the title property.
 boolean isEscape()
          Return the value of the escape property.
 void setEscape(boolean escape)
          Set the value of the escape property.
 void setLang(java.lang.String lang)
          Set the value of the lang property.
 void setStyle(java.lang.String style)
          Set the value of the style property.
 void setStyleClass(java.lang.String styleClass)
          Set the value of the styleClass property.
 void setTitle(java.lang.String title)
          Set the value of the title property.
 
Methods inherited from class javax.faces.component.UIMessage
getFor, isRedisplay, isShowDetail, isShowSummary, setFor, setRedisplay, setShowDetail, setShowSummary
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

MessageBase

public MessageBase()
Method Detail

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class javax.faces.component.UIMessage

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Note: setting this to false may open up security issues. See XSS (Cross Site Scripting) Prevention Cheat Sheet.

Specified by:
setEscape in interface IMessage

isEscape

public boolean isEscape()

Return the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Note: setting this to false may open up security issues. See XSS (Cross Site Scripting) Prevention Cheat Sheet. Default = 'true'.

Specified by:
isEscape in interface IMessage

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

Contents: Code describing the language used in the generated markup for this component.

Specified by:
setLang in interface IMessage

getLang

public java.lang.String getLang()

Return the value of the lang property.

Contents: Code describing the language used in the generated markup for this component.

Specified by:
getLang in interface IMessage

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: CSS style(s) to be applied when this component is rendered.

Specified by:
setStyle in interface IMessage

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: CSS style(s) to be applied when this component is rendered.

Specified by:
getStyle in interface IMessage

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Specified by:
setStyleClass in interface IMessage

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

Specified by:
getStyleClass in interface IMessage

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

Contents: Advisory title information about markup elements generated for this component.

Specified by:
setTitle in interface IMessage

getTitle

public java.lang.String getTitle()

Return the value of the title property.

Contents: Advisory title information about markup elements generated for this component.

Specified by:
getTitle in interface IMessage

ICEfaces ACE Components 3.3.0
Java API Documentation

Copyright 2013 ICEsoft Technologies Canada Corp., All Rights Reserved.