|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageBean
Interface implemented by all components that support messaging.
Method Summary | |
---|---|
java.lang.String |
getLabel()
Gets the label of the bean. |
java.lang.String |
getLongDescURL()
Gets an URL to a page with more information about the message. |
java.lang.String |
getMessage()
Gets the error, warning, or informational text. |
java.lang.String |
getMessageType()
Gets the type of the message; acceptable values are "error", "warning", "info", and "none". |
java.lang.String |
getRequired()
Gets whether the associated control requires user input. |
java.lang.String |
getTargetFrame()
Gets the target frame for the URL, if any. |
java.lang.String |
getTip()
Gets the tip text associated with the control |
void |
setLabel(java.lang.String label)
Sets the label of the bean. |
void |
setLongDescURL(java.lang.String longDescURL)
Sets an URL to a page with more information about the message. |
void |
setLongDescURLBinding(java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
void |
setLongDescURLBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
void |
setMessage(java.lang.String message)
Sets the error, warning, or informational text. |
void |
setMessageBinding(java.lang.Object selectKey)
Binds the the error, warning, or informational text. |
void |
setMessageBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the error, warning, or informational text. |
void |
setMessageType(java.lang.String messageType)
Sets the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageTypeBinding(java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageTypeBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setRequired(java.lang.String required)
Sets whether the associated control requires user input. |
void |
setTargetFrame(java.lang.String targetFrame)
Sets the target frame for the URL, if any. |
void |
setTip(java.lang.String tip)
Sets the tip text associated with the control |
Methods inherited from interface org.apache.myfaces.trinidadinternal.ui.MutableUINode |
---|
addIndexedChild, addIndexedChild, clearIndexedChildren, removeIndexedChild, replaceIndexedChild, setAttributeValue, setID, setNamedChild |
Methods inherited from interface org.apache.myfaces.trinidadinternal.ui.UINode |
---|
getAttributeNames, getAttributeValue, getChildNames, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeRole, getRawAttributeValue, getUIComponent, render, render |
Method Detail |
---|
java.lang.String getLabel()
void setLabel(java.lang.String label)
java.lang.String getTip()
void setTip(java.lang.String tip)
java.lang.String getMessageType()
void setMessageType(java.lang.String messageType)
void setMessageTypeBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.void setMessageTypeBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.java.lang.String getMessage()
void setMessage(java.lang.String message)
void setMessageBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.void setMessageBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.java.lang.String getLongDescURL()
void setLongDescURL(java.lang.String longDescURL)
void setLongDescURLBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.void setLongDescURLBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.java.lang.String getTargetFrame()
void setTargetFrame(java.lang.String targetFrame)
java.lang.String getRequired()
void setRequired(java.lang.String required)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |