|
© 2005 BEA Systems, Inc. | |||||||||
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 com.bea.netuix.servlets.controls.application.backing.DesktopBackingContext
The DesktopBackingContext
is used to interact with the underlying Desktop control. This is the
BackingContext for a Desktop.
This BackingContext
can only be referenced from a backing file. If you think you need to reference
this from a JSP you should look at DesktopPresentationContext
.
To get a handle to the BackingContext just call the following:
DesktopBackingContext.getDesktopBackingContext(request);
Note: most methods for retrieving child contexts do not work if called from the init()
method of a backing file. This is because the tree has not been fully initialized. You may have to call
the method from the preRender()
or handlePostbackData
method.
Field Summary | |
protected static String |
CLASS_NAME
|
Fields inherited from class com.bea.netuix.servlets.controls.ControlContext |
debug |
Method Summary | |
BookBackingContext |
getBookBackingContext()
Retrieve the main book (top level) backing context. |
BookBackingContext |
getBookBackingContextRecursive(String definitionLabel)
Return a book searching the entire tree recursively. |
String |
getDefinitionLabel()
Get definition label as defined in the portal file. |
static DesktopBackingContext |
getDesktopBackingContext(HttpServletRequest request)
Obtain a reference to the current DesktopBackingContext in the request.
|
LookAndFeelDefinitionId |
getLookAndFeelDefinitionId()
Return the look and feel definition id. |
String |
getLookAndFeelDefinitionLabel()
Return the look and feel definition label. |
PageBackingContext |
getPageBackingContextRecursive(String definitionLabel)
Return a book or a page but traverse the entire tree, this will go inside books that are on pages too. |
PortletBackingContext |
getPortletBackingContextRecursive(String instanceLabel)
Return the portlet backing context matching the supplied instance label. |
PortletBackingContext[] |
getPortletsBackingContextRecursive(String definitionLabel)
Return portlet backing contexts matching the supplied definition label. |
String |
getTitle()
Get the internationalized title for this desktop. |
void |
setTitle(String title)
Set a temporary value for the title. |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
getChildrenBackingContexts, getParentBackingContext, getTopParentBackingContext, isBackingPhase, isVisible, setBackingPhase, setVisible |
Methods inherited from class com.bea.netuix.servlets.controls.ControlContext |
getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final String CLASS_NAME
Method Detail |
public BookBackingContext getBookBackingContext()
public BookBackingContext getBookBackingContextRecursive(String definitionLabel)
getPageBackingContextRecursive()
as that method returns both.
Note: this method may return null if called from the init() method of a backing context.
definitionLabel
- of the book
public String getDefinitionLabel()
Get definition label as defined in the portal file.
public static DesktopBackingContext getDesktopBackingContext(HttpServletRequest request)
Obtain a reference to the current DesktopBackingContext
in the request.
Note: the DesktopBackingContext should only be obtained from a backing file. If you
think you need this context from a JSP look at DesktopPresentationContext.
request
- http servlet request.
public LookAndFeelDefinitionId getLookAndFeelDefinitionId()
public String getLookAndFeelDefinitionLabel()
public PageBackingContext getPageBackingContextRecursive(String definitionLabel)
definitionLabel
-
public PortletBackingContext getPortletBackingContextRecursive(String instanceLabel)
instanceLabel
- unique instance label of the portlet
public PortletBackingContext[] getPortletsBackingContextRecursive(String definitionLabel)
getPortletBackingContextRecursive(String instanceLabel)
Note: this method may return null if called from the init() method of a backing context.
definitionLabel
- label of the portlet
public String getTitle()
Get the internationalized title for this desktop.
public void setTitle(String title)
Set a temporary value for the title.
|
© 2005 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |