org.apache.myfaces.trinidadinternal.ui.beans.message
Interface MessageBean

All Superinterfaces:
MutableUINode, UINode

public interface MessageBean
extends MutableUINode

Interface implemented by all components that support messaging.

Version:
$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/ui/beans/message/MessageBean.java#0 $) $Date: 10-nov-2005.18:57:40 $
Author:
The Oracle ADF Faces Team

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

getLabel

java.lang.String getLabel()
Gets the label of the bean.


setLabel

void setLabel(java.lang.String label)
Sets the label of the bean.


getTip

java.lang.String getTip()
Gets the tip text associated with the control


setTip

void setTip(java.lang.String tip)
Sets the tip text associated with the control


getMessageType

java.lang.String getMessageType()
Gets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".


setMessageType

void setMessageType(java.lang.String messageType)
Sets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".


setMessageTypeBinding

void setMessageTypeBinding(java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setMessageTypeBinding

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". Defaults to "none".

Parameters:
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.

getMessage

java.lang.String getMessage()
Gets the error, warning, or informational text.


setMessage

void setMessage(java.lang.String message)
Sets the error, warning, or informational text.


setMessageBinding

void setMessageBinding(java.lang.Object selectKey)
Binds the the error, warning, or informational text.

Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setMessageBinding

void setMessageBinding(java.lang.String dataNamespace,
                       java.lang.String dataName,
                       java.lang.Object selectKey)
Binds the the error, warning, or informational text.

Parameters:
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.

getLongDescURL

java.lang.String getLongDescURL()
Gets an URL to a page with more information about the message.


setLongDescURL

void setLongDescURL(java.lang.String longDescURL)
Sets an URL to a page with more information about the message.


setLongDescURLBinding

void setLongDescURLBinding(java.lang.Object selectKey)
Binds the an URL to a page with more information about the message.

Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setLongDescURLBinding

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.

Parameters:
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.

getTargetFrame

java.lang.String getTargetFrame()
Gets the target frame for the URL, if any.


setTargetFrame

void setTargetFrame(java.lang.String targetFrame)
Sets the target frame for the URL, if any.


getRequired

java.lang.String getRequired()
Gets whether the associated control requires user input. Three values are allowed: "yes", "no", and "default". A visual indication will only be displayed if the value is set to "yes".


setRequired

void setRequired(java.lang.String required)
Sets whether the associated control requires user input. Three values are allowed: "yes", "no", and "default". A visual indication will only be displayed if the value is set to "yes".



Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.