|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectControlContext
com.bea.netuix.servlets.controls.BackingContext
com.bea.netuix.servlets.controls.window.backing.WindowBackingContext
public abstract class WindowBackingContext
This is the backing context class for a Window. Use this class when in a backing file to get information about the owning window. If you want to access this context from a JSP, look at WindowPresentationContext instead.
You can obtain the backing context for the active window by callingBackingContext.getContextFromRequest
BackingContext
Field Summary | |
---|---|
static String |
CLASS_NAME
|
Method Summary | |
---|---|
Capability |
getCapability(Capability capability)
Gets the capability for the Window, may be a state or a mode. |
boolean |
getCapabilityVisible(String name)
Gets the visible property for a capability. |
String |
getDefinitionId()
Return the definition id of this portlet, page or book. |
String |
getDefinitionLabel()
Get the definition label for the portlet/page or book. |
String |
getDescription()
Returns the description for the current window. |
String |
getInstanceId()
Return the instance id of this portlet. |
abstract String |
getLabel()
Return the label for the control. |
MetaData |
getMetaData(String name)
Return the metadata elements for this control matching the supplied name |
MetaData[] |
getMetaDatas()
Return the metadata elements for this control |
String |
getOrientation()
Get the orientation of the navigation bar or titlebar of the current window. |
PageBackingContext |
getParentPageBackingContext()
Return the window's parent page. |
BackingContext |
getParentWindowBackingContext()
Get the BackingContext of the parent of the current window. |
String |
getPlacementId()
Get the PlacementId for this window. |
WindowMode |
getPreviousWindowMode()
Get the previous WindowMode . |
WindowState |
getPreviousWindowState()
Get the previous WindowState . |
List |
getRenderedChildrenWindowBackingContexts()
This method returns a deep List containing all the Window, Page, and Book backing contexts of these type of controls that are rendered. |
String |
getTitle()
Get the title of the window. |
WindowMode |
getWindowMode()
Return the current window mode. |
WindowState |
getWindowState()
Return the current window state. |
boolean |
isCapable(Capability capability)
Determine if this control has the given capability. |
boolean |
isPacked()
Return true if the current window is packed. |
void |
setCapabilityVisible(String name,
boolean isVisible)
Sets the visible property for a capability. |
void |
setDescription(String description)
Set window description. |
void |
setTitle(String title)
Set the window's title. |
void |
setupModeChangeEvent(String modeValue)
Tell the window to change its mode. |
void |
setupModeChangeEvent(WindowMode modeValue)
Tell the window to change its mode. |
void |
setupPageChangeEvent(String pageLabel)
Tell the window to change the page. |
void |
setupStateChangeEvent(String stateValue)
Tell the window to change its state. |
void |
setupStateChangeEventFromParent(String stateValue)
Deprecated as of version 9.0 this method is deprecated. Use setupStateChangeEvent instead. |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
---|
ensureCurrentLifecycleStageLegalForOperation, getChildrenBackingContexts, getParentBackingContext, getTopParentBackingContext, isBackingPhase, isVisible, setBackingPhase, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String CLASS_NAME
Method Detail |
---|
public abstract String getLabel()
public String getTitle()
public void setCapabilityVisible(String name, boolean isVisible) throws NullPointerException
name
- the Capability
nameisVisible
- is it visible
NullPointerException
public boolean getCapabilityVisible(String name) throws NullPointerException
name
should be the Capability name.
name
- the Capability
name
NullPointerException
public void setTitle(String title)
Set the window's title. Note: this method only sets the title for the current request.
If you want to set the title permanently (and you are in streaming mode - not single file)
then use the PortalCustomizationManager
EJB.
title
- IPortletInstanceManager.updatePortletInstance(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId, com.bea.netuix.application.instance.PortletInstance)
public String getDescription()
public void setDescription(String description)
PortalCustomizationManager
EJB.
description
- IPortletInstanceManager.updatePortletInstance(com.bea.netuix.application.manager.CustomizationContext, com.bea.netuix.application.identifier.DesktopDefinitionId, com.bea.netuix.application.instance.PortletInstance)
public String getDefinitionLabel()
public String getInstanceId()
public String getDefinitionId()
public List getRenderedChildrenWindowBackingContexts()
public void setupModeChangeEvent(String modeValue)
modeValue
- the mode to change topublic void setupModeChangeEvent(WindowMode modeValue)
modeValue
- the mode to change topublic void setupStateChangeEventFromParent(String stateValue)
setupStateChangeEvent
instead.
stateValue
- the state to change topublic void setupStateChangeEvent(String stateValue)
stateValue
- the state to change topublic void setupPageChangeEvent(String pageLabel)
pageLabel
- the label of the page to change topublic WindowMode getWindowMode()
public WindowState getWindowState()
public String getOrientation()
public String getPlacementId()
PlacementId
for this window.
PlacementId
PlacementId
public boolean isPacked()
true
if the current window is packed.
public WindowState getPreviousWindowState()
WindowState
.
WindowState
public WindowMode getPreviousWindowMode()
WindowMode
.
WindowMode
public BackingContext getParentWindowBackingContext()
BackingContext
of the parent of the current window.
BackingContext
public boolean isCapable(Capability capability)
capability
- - window mode or stateWindowCapabilities
public Capability getCapability(Capability capability) throws NullPointerException
Gets the capability for the Window, may be a state or a mode. This method can be used to
check if a Window (Book, Page or Portlet) supports a given Mode or State. If you are intersted in
the current or active Window Mode or Window State you should use getWindowMode()
and getWindowState
repectively.
Note: this method should be called after the init()
lifcycle,
because the buttons have net yet registered with the parent window.
capability
- the Capability
to check for.
NullPointerException
WindowCapabilities
,
com.bea.netuix.servlets.controls;.Capability
,
com.bea.netuix.servlets.controls.window.WindowMode;
,
com.bea.netuix.servlets.controls.window.WindowState;
public PageBackingContext getParentPageBackingContext()
public MetaData[] getMetaDatas()
MetaData
objects
public MetaData getMetaData(String name)
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |