|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.servlets.controls.ControlContext
com.bea.netuix.servlets.controls.BackingContext
public abstract class BackingContext
Context base class for controls
that support a backing file. The control framework provides instances of subclasses of BackingContext
during actions and in backing files.
Method Summary | |
---|---|
protected void |
ensureCurrentLifecycleStageLegalForOperation(String operation, com.bea.netuix.nf.LifecycleStageFilter filter) |
List |
getChildrenBackingContexts() Returns a List of BackingContexts belonging to the children of the control this BackingContext represents that are BackableControls. |
BackingContext |
getParentBackingContext() Returns the BackingContext of the first ancestor that has one. |
Properties |
getParsedProperties() Get the extra properties of the component, if they exist. |
String |
getProperties() Get the extra properties string of the component, if it exists. |
String |
getProperty(String key) Get a property of the underlying component. |
String |
getProperty(String key, String defaultValue) Get a property of the underlying component, using the specified default if none exists. |
String |
getSendRedirectPath() Returns the redirect path if set, null otherwise. |
BackingContext |
getTopParentBackingContext() Returns the BackingContext of the upper most BackableControl in the tree. |
boolean |
isBackingPhase() Returns whether or not this is in the backing phase. |
boolean |
isVisible() Returns the value of the underlying control's visible attribute. |
void |
sendRedirect(String path) Redirects the client to the given path. |
protected void |
setBackingPhase(boolean backingPhase) Sets whether or not this is in the backing phase. |
void |
setVisible(boolean visible) Set the visible flag on the underlying control. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isVisible()
Returns the value of the underlying control's visible
attribute.
visible
attribute.public void setVisible(boolean visible)
visible
-public BackingContext getParentBackingContext()
Returns the BackingContext
of the first ancestor that has one.
public BackingContext getTopParentBackingContext()
Returns the BackingContext
of the upper most BackableControl in the tree.
public List getChildrenBackingContexts()
Returns a List
of BackingContexts
belonging to the children of the control this BackingContext
represents that are BackableControls. Note that this method returns BackingContexts
belonging to the immediate children only; in other words it is not a "deep" list of the children.
List
of BackingContext
public boolean isBackingPhase()
Returns whether or not this is in the backing phase. This method returns true during every lifecycle except render.
public void sendRedirect(String path)
Redirects the client to the given path. The path set should follow the same rules that apply to the sendRedirect
method in javax.servlet.http.HttpServletResponse
. This method should only be called in the handlePostbackData method on a backing file. Note that the actual redirect happens after executing the handlePostbackData
method on all backing files.
path
- pathpublic String getSendRedirectPath()
Returns the redirect path if set, null otherwise.
public String getProperties()
my-first-key: my-first-value; my-second-key: my-second-value;Any number of properties may be in a properties string.
getParsedProperties()
public Properties getParsedProperties()
Properties
class returned by this method is the parsed view of those from getProperties()
.getProperties()
public String getProperty(String key)
key
argument should not be null.key
- The property keypublic String getProperty(String key, String defaultValue)
key
argument should not be null.key
- The property keydefaultValue
- The value to use if no value is found for the specified keyprotected void setBackingPhase(boolean backingPhase)
Sets whether or not this is in the backing phase.
backingPhase
-protected final void ensureCurrentLifecycleStageLegalForOperation(String operation, com.bea.netuix.nf.LifecycleStageFilter filter)
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.