|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.faces.component.UIComponent javax.faces.component.UIComponentBase javax.faces.component.UIMessage javax.faces.component.html.HtmlMessage org.apache.myfaces.component.html.ext.AbstractHtmlMessage org.apache.myfaces.component.html.ext.HtmlMessage
public class HtmlMessage
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_RENDERER_TYPE
|
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.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 |
restoreState(javax.faces.context.FacesContext facesContext,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext facesContext)
|
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, isShowDetail, isShowSummary, setFor, setShowDetail, setShowSummary |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String DEFAULT_RENDERER_TYPE
Constructor Detail |
---|
public HtmlMessage()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIMessage
public java.lang.String getOnclick()
EventAware
public void setOnclick(java.lang.String onclick)
public java.lang.String getOndblclick()
EventAware
public void setOndblclick(java.lang.String ondblclick)
public java.lang.String getOnkeydown()
EventAware
public void setOnkeydown(java.lang.String onkeydown)
public java.lang.String getOnkeypress()
EventAware
public void setOnkeypress(java.lang.String onkeypress)
public java.lang.String getOnkeyup()
EventAware
public void setOnkeyup(java.lang.String onkeyup)
public java.lang.String getOnmousedown()
EventAware
public void setOnmousedown(java.lang.String onmousedown)
public java.lang.String getOnmousemove()
EventAware
public void setOnmousemove(java.lang.String onmousemove)
public java.lang.String getOnmouseout()
EventAware
public void setOnmouseout(java.lang.String onmouseout)
public java.lang.String getOnmouseover()
EventAware
public void setOnmouseover(java.lang.String onmouseover)
public java.lang.String getOnmouseup()
EventAware
public void setOnmouseup(java.lang.String onmouseup)
public java.lang.String getEnabledOnUserRole()
UserRoleAware
public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
public java.lang.String getVisibleOnUserRole()
UserRoleAware
public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
public boolean isForceId()
ForceIdAware
public void setForceId(boolean forceId)
public boolean isForceIdIndex()
ForceIdAware
public void setForceIdIndex(boolean forceIdIndex)
public java.lang.String getDir()
UniversalProperties
public void setDir(java.lang.String dir)
public java.lang.String getLang()
UniversalProperties
public void setLang(java.lang.String lang)
public java.lang.String getTitle()
UniversalProperties
getTitle
in interface UniversalProperties
getTitle
in class javax.faces.component.html.HtmlMessage
public void setTitle(java.lang.String title)
setTitle
in class javax.faces.component.html.HtmlMessage
public java.lang.String getSummaryFormat()
MessageProperties
public void setSummaryFormat(java.lang.String summaryFormat)
public java.lang.String getDetailFormat()
MessageProperties
public void setDetailFormat(java.lang.String detailFormat)
public boolean isReplaceIdWithLabel()
MessageProperties
public void setReplaceIdWithLabel(boolean replaceIdWithLabel)
public boolean isForceSpan()
MessageProperties
public void setForceSpan(boolean forceSpan)
public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.html.HtmlMessage
public void restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.html.HtmlMessage
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |