BackingContext Class

com.bea.netuix.servlets.controls
BackingContext Class

public abstract class BackingContext

    extends ControlContext

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.


Hierarchy
Object
  ControlContext
    BackingContext
All Implemented Interfaces

Serializable
Direct Known Subclasses

DesktopBackingContext, WindowBackingContext

Field Summary

   
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary

 

Method Summary

public List
getChildrenBackingContexts()

Returns a List of BackingContexts belonging to the children of the control this BackingContext represents that are BackableControls.

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 boolean
isBackingPhase()

Returns whether or not this is in the backing phase.

public boolean
isVisible()

Returns the value of the underlying control's visible attribute.

protected void
setBackingPhase(boolean backingPhase)

Sets whether or not this is in the backing phase.

public void
setVisible(boolean visible)
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail


 

Method Detail

getChildrenBackingContexts() Method

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.

Returns

List of BackingContext

getParentBackingContext() Method

public BackingContext getParentBackingContext()

Returns the BackingContext of the first ancestor that has one.

Returns

the BackingContext of the first ancestor that is a BackableControl. If there are no BackableControls among the ancestors returns null.

getTopParentBackingContext() Method

public BackingContext getTopParentBackingContext()

Returns the BackingContext of the upper most BackableControl in the tree.

Returns

the BackingContext of the upper most ancestor that is a BackableControl. If there are no BackableControls among the ancestors returns null.

isBackingPhase() Method

public boolean isBackingPhase()

Returns whether or not this is in the backing phase. This method returns true during every lifecycle except render.

Returns

return true if we are in the backing phase of the lifecycle.

isVisible() Method

public boolean isVisible()

Returns the value of the underlying control's visible attribute.

Returns

a boolean, the value of the underlying control's visible attribute.

setBackingPhase(boolean) Method

protected void setBackingPhase(boolean backingPhase)

Sets whether or not this is in the backing phase.


setVisible(boolean) Method

public void setVisible(boolean visible)