| java.lang.Object
 com.sun.rave.web.ui.appbase.FacesBean
All known Subclasses: com.sun.rave.web.ui.appbase.AbstractPageBean, com.sun.rave.web.ui.appbase.AbstractFragmentBean, com.sun.rave.web.ui.appbase.AbstractApplicationBean, com.sun.rave.web.ui.appbase.AbstractRequestBean, com.sun.rave.web.ui.appbase.AbstractSessionBean,
| FacesBean | | abstract public class FacesBean (Code) | | FacesBean is the abstract base class for all page beans,
request scope data beans, session scope data beans, and application scope
data beans that wish to participate in the provided JavaServer Faces
integration support. Concrete subclasses of this class will typically
be registered as managed beans, so that they get created on demand
(and added to the relevant scope's attributes).
NOTE - These integration methods will operate
successfully only within the lifetime of a JavaServer Faces
request.
|
| Method Summary | |
| protected void | erase()
Erase previously submitted values for all input components on this
page. | | protected void | error(String summary)
Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_ERROR. | | protected void | error(UIComponent component, String summary)
Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_ERROR. | | protected void | fatal(String summary)
Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_FATAL. | | protected void | fatal(UIComponent component, String summary)
Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_FATAL. | | protected Application | getApplication()
| | protected Map | getApplicationMap()
| | protected Object | getBean(String name)
Return any attribute stored in request scope, session scope, or
application scope under the specified name. | | protected List | getCachedExceptions()
Return a List of the exceptions that have been
logged, swallowed, and cached during the processing of this request
so far. | | protected FacesContext | getContext()
Return the FacesContext instance for the current
request. | | protected ExternalContext | getExternalContext()
| | protected FacesContext | getFacesContext()
| | protected Lifecycle | getLifecycle()
| | protected Map | getRequestMap()
| | protected Map | getSessionMap()
Return a Map of the session scope attributes for the
current user's session. | | protected Object | getValue(String expr)
| | protected void | info(String summary)
Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_INFO. | | protected void | info(UIComponent component, String summary)
Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_INFO. | | protected void | log(String message)
| | protected void | log(String message, Throwable throwable)
| | public Object | retrieveData(String key)
Return the data object stored (typically when the component tree
was previously rendered) under the specified key, if any; otherwise,
return null.
IMPLEMENTATION NOTE: Data objects will become
available only after the Restore View phase of the request
processing lifecycle has been completed. | | public void | saveData(String key, Object data)
Save the specified data object (which MUST be
Serializable) under the specified key, such that it can
be retrieved (via getData()) on a s subsequent request
immediately after the component tree has been restored.
IMPLEMENTATION NOTE: In order to successfully save
data objects, this method must be called before the Render Response
phase of the request processing lifecycle is executed. | | protected void | setBean(String name, Object value)
Replace the value of any attribute stored in request scope,
session scope, or application scope under the specified name. | | protected void | setValue(String expr, Object value)
| | protected void | warn(String summary)
Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_WARN. | | protected void | warn(UIComponent component, String summary)
Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_WARN. |
| FacesBean | | public FacesBean()(Code) | | |
| erase | | protected void erase()(Code) | | Erase previously submitted values for all input components on this
page. This method MUST be called if you have bound
input components to database columns, and then arbitrarily navigate
the underlying RowSet to a different row in an event
handler method.
|
| error | | protected void error(String summary)(Code) | | Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_ERROR.
Parameters:
summary - Summary text for this message |
| error | | protected void error(UIComponent component, String summary)(Code) | | Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_ERROR.
Parameters:
component - Component with which this message is associated
Parameters:
summary - Summary text for this message |
| fatal | | protected void fatal(String summary)(Code) | | Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_FATAL.
Parameters:
summary - Summary text for this message |
| fatal | | protected void fatal(UIComponent component, String summary)(Code) | | Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_FATAL.
Parameters:
component - Component with which this message is associated
Parameters:
summary - Summary text for this message |
| getApplication | | protected Application getApplication()(Code) | | Return the Application instance for the current
web application.
|
| getApplicationMap | | protected Map getApplicationMap()(Code) | | Return a Map of the application scope attributes
for this web application.
|
| getBean | | protected Object getBean(String name)(Code) | | Return any attribute stored in request scope, session scope, or
application scope under the specified name. If no such
attribute is found, and if this name is the registered name of a
managed bean, cause a new instance of this managed bean to be created
(and stored in an appropriate scope, if necessary) and returned.
If no attribute exists, and no managed bean was created, return
null.
Parameters:
name - Name of the attribute to be retrieved |
| getCachedExceptions | | protected List getCachedExceptions()(Code) | | Return a List of the exceptions that have been
logged, swallowed, and cached during the processing of this request
so far. If there are no such cached exceptions, return null
instead.
The application runtime framework causes exceptions thrown from
any of the following sources to be logged (to the application server's
log), swallowed, and added to this list:
- Application lifecycle methods (
init(), preprocess(),
prerender(), and destroy()) on an
AbstractPageBean .
- Phase listener methods (
beforeXxx(), afterXxx())
on an
AbstractPageBean .
- Exception thrown during the rendering of the selected view during
Render Response phase of the request processing lifecycle.
|
| getContext | | protected FacesContext getContext()(Code) | | Return the FacesContext instance for the current
request. This method has been restored for backwards compatibilty.
|
| getExternalContext | | protected ExternalContext getExternalContext()(Code) | | Return the ExternalContext instance for the
current request.
|
| getFacesContext | | protected FacesContext getFacesContext()(Code) | | Return the FacesContext instance for the current
request.
|
| getLifecycle | | protected Lifecycle getLifecycle()(Code) | | Return the configured Lifecycle instance for the
current web application.
|
| getRequestMap | | protected Map getRequestMap()(Code) | | Return a Map of the request scope attributes for
the current request.
|
| getSessionMap | | protected Map getSessionMap()(Code) | | Return a Map of the session scope attributes for the
current user's session. Note that calling this method will cause a
session to be created if there is not already one associated with
this request.
|
| getValue | | protected Object getValue(String expr)(Code) | | Evaluate the specified value binding expression, and return
the value that it points at.
Parameters:
expr - Value binding expression (including delimiters) |
| info | | protected void info(String summary)(Code) | | Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_INFO.
Parameters:
summary - Summary text for this message |
| info | | protected void info(UIComponent component, String summary)(Code) | | Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_INFO.
Parameters:
component - Component with which this message is associated
Parameters:
summary - Summary text for this message |
| log | | protected void log(String message)(Code) | | Log the specified message to the container's log file.
Parameters:
message - Message to be logged |
| log | | protected void log(String message, Throwable throwable)(Code) | | Log the specified message and exception to the container's
log file.
Parameters:
message - Message to be logged
Parameters:
throwable - Exception to be logged |
| retrieveData | | public Object retrieveData(String key)(Code) | | Return the data object stored (typically when the component tree
was previously rendered) under the specified key, if any; otherwise,
return null.
IMPLEMENTATION NOTE: Data objects will become
available only after the Restore View phase of the request
processing lifecycle has been completed. A common place to reinitialize
state information, then, would be in the preprocess()
event handler of a page bean.
Parameters:
key - Key under which to retrieve the requested data |
| saveData | | public void saveData(String key, Object data)(Code) | | Save the specified data object (which MUST be
Serializable) under the specified key, such that it can
be retrieved (via getData()) on a s subsequent request
immediately after the component tree has been restored.
IMPLEMENTATION NOTE: In order to successfully save
data objects, this method must be called before the Render Response
phase of the request processing lifecycle is executed. A common scenario
is to save state information in the prerender() event handler
of a page bean.
Parameters:
key - Key under which to store the requested data
Parameters:
data - Data object to be stored |
| setBean | | protected void setBean(String name, Object value)(Code) | | Replace the value of any attribute stored in request scope,
session scope, or application scope under the specified name. If there
is no such attribute, create a new request scope attribute under this
name, and store the value there.
|
| setValue | | protected void setValue(String expr, Object value)(Code) | | Evaluate the specified value binding expression, and update
the value that it points at.
Parameters:
expr - Value binding expression (including delimiters) thatmust point at a writeable property
Parameters:
value - New value for the property pointed at by expr |
| warn | | protected void warn(String summary)(Code) | | Enqueue a global FacesMessage (not associated
with any particular componen) containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_WARN.
Parameters:
summary - Summary text for this message |
| warn | | protected void warn(UIComponent component, String summary)(Code) | | Enqueue a FacesMessage associated with the
specified component, containing the specified summary text
and a message severity level of FacesMessage.SEVERITY_WARN.
Parameters:
component - Component with which this message is associated
Parameters:
summary - Summary text for this message |
|
|