|
© 2003 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.window.backing.WindowBackingContext
Field Summary |
Fields inherited from class com.bea.netuix.servlets.controls.ControlContext |
debug |
Constructor Summary | |
protected |
WindowBackingContext(Window window)
|
Method Summary | |
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()
Getter fo rthe definition label for the portlet/page or book. |
String |
getDescription()
Returns the desscription for the current window. |
String |
getInstanceId()
Return the instance id of this portlet. |
abstract String |
getLabel()
Return the label for the control. |
String |
getOrientation()
Returns the orientation of the navigation bar or titlebar of the current window. |
BackingContext |
getParentWindowBackingContext()
Returns the BackingContext of the parent of the current window. |
String |
getPlacementId()
Returns the PlacementId for this window. |
WindowMode |
getPreviousWindowMode()
Returns previous WindowMode . |
WindowState |
getPreviousWindowState()
Returns 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()
|
WindowMode |
getWindowMode()
Returns the current window mode. |
WindowState |
getWindowState()
Returns the current window state. |
boolean |
isCapable(Capability capability)
Returns true if this control has the given
capability. |
boolean |
isPacked()
Returns 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)
Sets up a mode change event. |
void |
setupModeChangeEvent(WindowMode modeValue)
Sets up a mode change event. |
void |
setupPageChangeEvent(String pageLabel)
Sets up a page change event. |
void |
setupStateChangeEvent(String stateValue)
Sets up a state change event. |
Methods inherited from class com.bea.netuix.servlets.controls.BackingContext |
getChildrenBackingContexts, getContextFromRequest, 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 |
Constructor Detail |
protected WindowBackingContext(Window window)
Method Detail |
public abstract String getLabel()
public String getTitle()
public void setCapabilityVisible(String name, boolean isVisible) throws NullPointerException
name
should be the Capability name.
This must be called in the pre-render method or earlier, and
is reset upon every new request.
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 permenately (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
- modepublic void setupModeChangeEvent(WindowMode modeValue)
modeValue
- modepublic void setupStateChangeEvent(String stateValue)
stateValue
- statepublic void setupPageChangeEvent(String pageLabel)
pageLabel
- page labelpublic WindowMode getWindowMode()
Returns the current window mode.
public WindowState getWindowState()
Returns the current window state.
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)
Returns true
if this control has the given
capability.
capability
- - window mode or stateWindowCapabilities
|
© 2003 BEA Systems, Inc. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |