org.apache.myfaces.component.html.ext
Class HtmlMessage

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIMessage
              extended by javax.faces.component.html.HtmlMessage
                  extended by org.apache.myfaces.component.html.ext.AbstractHtmlMessage
                      extended by org.apache.myfaces.component.html.ext.HtmlMessage
All Implemented Interfaces:
java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, EventAware, ForceIdAware, MessageProperties, UniversalProperties, UserRoleAware

public class HtmlMessage
extends AbstractHtmlMessage


Nested Class Summary
protected static class HtmlMessage.PropertyKeys
           
 
Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String DEFAULT_RENDERER_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlMessage()
           
 
Method Summary
 java.lang.String getDetailFormat()
          If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created.
 java.lang.String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 java.util.Collection<java.lang.String> getEventNames()
           
 java.lang.String getFamily()
           
 java.lang.String getLang()
          HTML: The base language of this document.
 java.lang.String getOnclick()
          HTML: Script to be invoked when the element is clicked.
 java.lang.String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
 java.lang.String getOnkeydown()
          HTML: Script to be invoked when a key is pressed down over this element.
 java.lang.String getOnkeypress()
          HTML: Script to be invoked when a key is pressed over this element.
 java.lang.String getOnkeyup()
          HTML: Script to be invoked when a key is released over this element.
 java.lang.String getOnmousedown()
          HTML: Script to be invoked when the pointing device is pressed over this element.
 java.lang.String getOnmousemove()
          HTML: Script to be invoked when the pointing device is moved while it is in this element.
 java.lang.String getOnmouseout()
          HTML: Script to be invoked when the pointing device is moves out of this element.
 java.lang.String getOnmouseover()
          HTML: Script to be invoked when the pointing device is moved into this element.
 java.lang.String getOnmouseup()
          HTML: Script to be invoked when the pointing device is released over this element.
 java.lang.String getSummaryFormat()
          If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created.
 java.lang.String getTitle()
          HTML: An advisory title for this element.
 java.lang.String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 boolean isForceId()
          If true, this component will force the use of the specified id when rendering.
 boolean isForceIdIndex()
          If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
 boolean isForceSpan()
          If set to true, an empty span element is rendered.
 boolean isReplaceIdWithLabel()
          If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label.
 void setDetailFormat(java.lang.String detailFormat)
           
 void setDir(java.lang.String dir)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setForceId(boolean forceId)
           
 void setForceIdIndex(boolean forceIdIndex)
           
 void setForceSpan(boolean forceSpan)
           
 void setLang(java.lang.String lang)
           
 void setOnclick(java.lang.String onclick)
           
 void setOndblclick(java.lang.String ondblclick)
           
 void setOnkeydown(java.lang.String onkeydown)
           
 void setOnkeypress(java.lang.String onkeypress)
           
 void setOnkeyup(java.lang.String onkeyup)
           
 void setOnmousedown(java.lang.String onmousedown)
           
 void setOnmousemove(java.lang.String onmousemove)
           
 void setOnmouseout(java.lang.String onmouseout)
           
 void setOnmouseover(java.lang.String onmouseover)
           
 void setOnmouseup(java.lang.String onmouseup)
           
 void setReplaceIdWithLabel(boolean replaceIdWithLabel)
           
 void setSummaryFormat(java.lang.String summaryFormat)
           
 void setTitle(java.lang.String title)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 
Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlMessage
getClientId, getForceSpan, isRendered
 
Methods inherited from class javax.faces.component.html.HtmlMessage
getErrorClass, getErrorStyle, getFatalClass, getFatalStyle, getInfoClass, getInfoStyle, getStyle, getStyleClass, getWarnClass, getWarnStyle, isTooltip, setErrorClass, setErrorStyle, setFatalClass, setFatalStyle, setInfoClass, setInfoStyle, setStyle, setStyleClass, setTooltip, setWarnClass, setWarnStyle
 
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, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName
 

Field Detail

COMPONENT_FAMILY

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

COMPONENT_TYPE

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

DEFAULT_RENDERER_TYPE

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

HtmlMessage

public HtmlMessage()
Method Detail

getFamily

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

getEventNames

public java.util.Collection<java.lang.String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getEventNames in class javax.faces.component.UIComponentBase

getOnclick

public java.lang.String getOnclick()
Description copied from interface: EventAware
HTML: Script to be invoked when the element is clicked.


setOnclick

public void setOnclick(java.lang.String onclick)

getOndblclick

public java.lang.String getOndblclick()
Description copied from interface: EventAware
HTML: Script to be invoked when the element is double-clicked.


setOndblclick

public void setOndblclick(java.lang.String ondblclick)

getOnkeydown

public java.lang.String getOnkeydown()
Description copied from interface: EventAware
HTML: Script to be invoked when a key is pressed down over this element.


setOnkeydown

public void setOnkeydown(java.lang.String onkeydown)

getOnkeypress

public java.lang.String getOnkeypress()
Description copied from interface: EventAware
HTML: Script to be invoked when a key is pressed over this element.


setOnkeypress

public void setOnkeypress(java.lang.String onkeypress)

getOnkeyup

public java.lang.String getOnkeyup()
Description copied from interface: EventAware
HTML: Script to be invoked when a key is released over this element.


setOnkeyup

public void setOnkeyup(java.lang.String onkeyup)

getOnmousedown

public java.lang.String getOnmousedown()
Description copied from interface: EventAware
HTML: Script to be invoked when the pointing device is pressed over this element.


setOnmousedown

public void setOnmousedown(java.lang.String onmousedown)

getOnmousemove

public java.lang.String getOnmousemove()
Description copied from interface: EventAware
HTML: Script to be invoked when the pointing device is moved while it is in this element.


setOnmousemove

public void setOnmousemove(java.lang.String onmousemove)

getOnmouseout

public java.lang.String getOnmouseout()
Description copied from interface: EventAware
HTML: Script to be invoked when the pointing device is moves out of this element.


setOnmouseout

public void setOnmouseout(java.lang.String onmouseout)

getOnmouseover

public java.lang.String getOnmouseover()
Description copied from interface: EventAware
HTML: Script to be invoked when the pointing device is moved into this element.


setOnmouseover

public void setOnmouseover(java.lang.String onmouseover)

getOnmouseup

public java.lang.String getOnmouseup()
Description copied from interface: EventAware
HTML: Script to be invoked when the pointing device is released over this element.


setOnmouseup

public void setOnmouseup(java.lang.String onmouseup)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()
Description copied from interface: UserRoleAware
If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

isForceId

public boolean isForceId()
Description copied from interface: ForceIdAware
If true, this component will force the use of the specified id when rendering.

Returns:

setForceId

public void setForceId(boolean forceId)

isForceIdIndex

public boolean isForceIdIndex()
Description copied from interface: ForceIdAware
If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)

Returns:

setForceIdIndex

public void setForceIdIndex(boolean forceIdIndex)

getDir

public java.lang.String getDir()
Description copied from interface: UniversalProperties
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Specified by:
getDir in interface UniversalProperties
Overrides:
getDir in class javax.faces.component.html.HtmlMessage

setDir

public void setDir(java.lang.String dir)
Overrides:
setDir in class javax.faces.component.html.HtmlMessage

getLang

public java.lang.String getLang()
Description copied from interface: UniversalProperties
HTML: The base language of this document.

Specified by:
getLang in interface UniversalProperties
Overrides:
getLang in class javax.faces.component.html.HtmlMessage

setLang

public void setLang(java.lang.String lang)
Overrides:
setLang in class javax.faces.component.html.HtmlMessage

getTitle

public java.lang.String getTitle()
Description copied from interface: UniversalProperties
HTML: An advisory title for this element. Often used by the user agent as a tooltip.

Specified by:
getTitle in interface UniversalProperties
Overrides:
getTitle in class javax.faces.component.html.HtmlMessage

setTitle

public void setTitle(java.lang.String title)
Overrides:
setTitle in class javax.faces.component.html.HtmlMessage

getSummaryFormat

public java.lang.String getSummaryFormat()
Description copied from interface: MessageProperties
If present, instead of rendering the message summary, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message summary as the first argument and the label of the associated component (if any) as the second argument. Example: "{0}:"


setSummaryFormat

public void setSummaryFormat(java.lang.String summaryFormat)

getDetailFormat

public java.lang.String getDetailFormat()
Description copied from interface: MessageProperties
If present, instead of rendering the message detail, a MessageFormat with this attribute as pattern is created. The format method of this MessageFormat is called with the message detail as the first argument and the label of the associated component (if any) as the second argument. Example: "The input in field {1} is wrong: {0}"


setDetailFormat

public void setDetailFormat(java.lang.String detailFormat)

isReplaceIdWithLabel

public boolean isReplaceIdWithLabel()
Description copied from interface: MessageProperties
If present, all occurrences of the id of the component for which the message is rendered will be replaced by the label. Default: true.


setReplaceIdWithLabel

public void setReplaceIdWithLabel(boolean replaceIdWithLabel)

isForceSpan

public boolean isForceSpan()
Description copied from interface: MessageProperties
If set to true, an empty span element is rendered. Useful if there is an inputAjax field and the corresponding error message is displayed there.


setForceSpan

public void setForceSpan(boolean forceSpan)


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.