|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
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.PresentationContext com.bea.netuix.servlets.controls.application.DesktopPresentationContext
public class DesktopPresentationContext
This class represents a portal desktop component. All presentation-related attributes of a desktop component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. desktop.jsp).
getDesktopPresentationContext(javax.servlet.http.HttpServletRequest)
,
Serialized FormField Summary | |
---|---|
protected static String |
CLASS_NAME
|
Method Summary | |
---|---|
BookPresentationContext |
getBookPresentationContext()
Retrieve the main book (top level) presentation context. |
BookPresentationContext |
getBookPresentationContextRecursive(String definitionLabel)
Returns a book's presentation context, searching the entire tree recursively. |
String |
getDefinitionLabel()
Returns the definitionLabel of this desktop. |
static DesktopPresentationContext |
getDesktopPresentationContext(javax.servlet.http.HttpServletRequest request)
This is a convenience method for returning a reference to the one and only DesktopPresentationContext . |
PagePresentationContext |
getDisplayedPagePresentationContext()
Return the last displayed page (not book). |
HeaderPresentationContext |
getHeaderPresentationContext()
Get the header context for this desktop. |
LookAndFeelDefinitionId |
getLookAndFeelDefinitionId()
Return the look and feel definition id. |
String |
getLookAndFeelDefinitionLabel()
Return the look and feel definition label. |
PagePresentationContext |
getPagePresentationContextRecursive(String definitionLabel)
Return a book or a page but traverse the entire tree; this will go inside books that are on pages too. |
PortletPresentationContext |
getPortletPresentationContextRecursive(String instanceLabel)
Return the portlet presentation context matching the supplied instance label. |
PortletPresentationContext[] |
getPortletsPresentationContextRecursive(String definitionLabel)
Return all portlet presentation contexts matching the supplied definition label. |
ShellPresentationContext |
getShellPresentationContext()
Return a reference to the shell presentation context. |
String |
getTitle()
Returns the title of this desktop instance. |
boolean |
isAsyncModeDisabled()
Was desktop asyncMode set to disabled for this request? |
boolean |
isAsyncModeEnabled()
Was desktop asyncMode set to enabled for this request? |
boolean |
isDiscEnabled()
Is the Desktop attribute discEnabled currently set to true? Disc is WLP's Dynamic Interface Scripting environment, a JavaScript framework for client-side development. |
boolean |
isDvtEnabled()
Is the Desktop attribute dvtEnabled currently set to true? This flag enables or disables dynamic visitor tooling functionality. |
Methods inherited from class com.bea.netuix.servlets.controls.PresentationContext |
---|
getAttributeRenderer, getChildren, getChildren, getFirstChild, getOrderedChildren, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, isVisible, setVisible |
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 static DesktopPresentationContext getDesktopPresentationContext(javax.servlet.http.HttpServletRequest request)
DesktopPresentationContext
.
Note this method will only work if called from within a portal (typically, from the desktop.jsp skeleton).
This method may return null if called when no appropriate context exists, but such a context should safely
exist when being fetched from the associated skeleton JSP during normal portal rendering.
request
- The current HTTPServletRequest instance
public ShellPresentationContext getShellPresentationContext()
getFirstChild("application:shell")
.
#getChildren(String)
public LookAndFeelDefinitionId getLookAndFeelDefinitionId()
public String getLookAndFeelDefinitionLabel()
public BookPresentationContext getBookPresentationContext()
public BookPresentationContext getBookPresentationContextRecursive(String definitionLabel)
getPagePresentationContextRecursive()
as that method returns both.
definitionLabel
- The definition label of the book of interest
public PagePresentationContext getPagePresentationContextRecursive(String definitionLabel)
definitionLabel
- The definition label of the page or book of interest
public PortletPresentationContext getPortletPresentationContextRecursive(String instanceLabel)
instanceLabel
- The unique instance label of the desired portlet
public PortletPresentationContext[] getPortletsPresentationContextRecursive(String definitionLabel)
getPortletPresentationContextRecursive(String instanceLabel)
.
definitionLabel
- The label of the desired portlet
public PagePresentationContext getDisplayedPagePresentationContext()
public String getTitle()
public String getDefinitionLabel()
public HeaderPresentationContext getHeaderPresentationContext()
public boolean isAsyncModeEnabled()
public boolean isAsyncModeDisabled()
public boolean isDiscEnabled()
public boolean isDvtEnabled()
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |