|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
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.window.backing.WindowBackingContext com.bea.netuix.servlets.controls.page.PageBackingContext
public class PageBackingContext
This is the backing context for a page. As such, it is meant to be called from backing files or pageflows. If you want to access this context from a JSP, look at PagePresentationContext instead.
CallgetContextFromRequest
to obtain the backing context for the active window.
Field Summary | |
---|---|
protected static String |
CLASS_NAME
|
Method Summary | |
---|---|
String |
getActiveImage()
Get the path to the image displayed in the menu tab when the page is active. |
BookBackingContext |
getBookBackingContextRecursive(String definitionLabel)
Return a book searching the entire tree recursively. |
String |
getInactiveImage()
Get the path to the image displayed in the menu tab when the page is inactive. |
String |
getLabel()
Returns the definition label on the page |
String |
getMarkupName()
Returns the value of the Page's markupName attribute. |
String |
getMarkupType()
Returns the value of the Page's markupType attribute. |
static PageBackingContext |
getPageBackingContext(javax.servlet.http.HttpServletRequest request)
Get the PageBackingContext from the request |
PageBackingContext |
getPageBackingContextRecursive(String definitionLabel)
Return a book or a page but traverse the entire tree. |
BookBackingContext |
getParentBookBackingContext()
Returns the BookBackingContext of the book that is the parent of the page represented by this context. |
PageBackingContext |
getParentPageBackingContext()
Returns the PageBackingContext of the Page that is the parent of the page represented by this context. |
PortletBackingContext |
getPortletBackingContextRecursive(String instanceLabel)
Return the portlet backing context matching the supplied instance label. Note: this method may return null if called from the init() method of a backing context. |
PortletBackingContext[] |
getPortletsBackingContextRecursive(String definitionLabel)
Return portlet backing contexts matching the supplied definition label. |
String |
getRolloverImage()
Get the path to the rollover image to be displayed on the menu tab for this page. |
List |
getWindowBackingContexts()
Return the collection of child WindowBackingContexts (BookBackingContext or PortletBackingContext) for this page. |
boolean |
isActive()
Return true if this page is active. |
boolean |
isDisplayed()
Return true if this page is going to be displayed. |
boolean |
isHidden()
Return the value of the underlying object's hidden
attribute. |
void |
setActive(boolean active)
Set the value of the underlying object's active
attribute. |
void |
setActiveImage(String activeImage)
Set the path to the image displayed in the menu tab when the page is active. |
void |
setHidden(boolean hidden)
Set the value of the underlying object's hidden
attribute. |
void |
setInactiveImage(String inactiveImage)
Set the path to the image displayed in the menu tab when the page is already active. |
void |
setRolloverImage(String rolloverImage)
Set the path to the rollover image to be displayed on the menu tab for this page. |
Methods inherited from class com.bea.netuix.servlets.controls.window.backing.WindowBackingContext |
---|
getCapability, getCapabilityVisible, getDefinitionId, getDefinitionLabel, getDescription, getInstanceId, getMetaData, getMetaDatas, getOrientation, getParentWindowBackingContext, getPlacementId, getPreviousWindowMode, getPreviousWindowState, getRenderedChildrenWindowBackingContexts, getTitle, getWindowMode, getWindowState, isCapable, isPacked, setCapabilityVisible, setDescription, setTitle, setupModeChangeEvent, setupModeChangeEvent, setupPageChangeEvent, setupStateChangeEvent, setupStateChangeEventFromParent |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
---|
ensureCurrentLifecycleStageLegalForOperation, getChildrenBackingContexts, getParentBackingContext, getParsedProperties, getProperties, getProperty, getProperty, getSendRedirectPath, getTopParentBackingContext, isBackingPhase, isVisible, sendRedirect, setBackingPhase, 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 String getLabel()
getLabel
in class WindowBackingContext
public BookBackingContext getParentBookBackingContext()
Page.getBook()
public String getMarkupName()
public String getMarkupType()
public PageBackingContext getParentPageBackingContext()
getParentPageBackingContext
in class WindowBackingContext
Page.getParentPage()
public boolean isActive()
isDisplayed
in that an active page is not necessarily always displayed as the parent book may not be active.
Active pages can have an inactive parent book but when the parent is activated again the
current page is remembered.
public boolean isHidden()
hidden
attribute. A hidden page is a page that does not show up as a tab in a book's menu. It may
still be activated via links and events, however.
hidden
attribute.public void setActive(boolean active)
active
attribute. A hidden page is a page that does not show up as a tab in a book's menu. It may
still be activated via links and events, however.
active
- boolean, the new value of the underlying object's active
attribute.public void setHidden(boolean hidden)
hidden
attribute.
hidden
- boolean, the new value of the underlying object's hidden
attribute.public static PageBackingContext getPageBackingContext(javax.servlet.http.HttpServletRequest request)
public String getActiveImage()
public void setActiveImage(String activeImage)
activeImage
- a URI to the new activate image.public String getInactiveImage()
public void setInactiveImage(String inactiveImage)
inactiveImage
- public String getRolloverImage()
public void setRolloverImage(String rolloverImage)
rolloverImage
- public boolean isDisplayed()
Return true if this page is going to be displayed.
This method should be called late in the lifecycle preRender()
to determine if this
page will be displayed. If called earlier in the lifecycle handlePostBackData()
it will return
true if the page was previously display.
isActive
in that an active page is not necessarily always displayed as the parent book may not be active.
public List getWindowBackingContexts()
Return the collection of child WindowBackingContexts (BookBackingContext or PortletBackingContext) for this page. If no portlets and books exist returns an empty list.
BookBackingContext and PortletBackingContext
s objectspublic BookBackingContext getBookBackingContextRecursive(String definitionLabel)
getPageBackingContextRecursive()
as that method returns both.
definitionLabel
- of the book
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)
.
definitionLabel
- label of the portlet
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |