WindowBackingContext Class

com.bea.netuix.servlets.controls.window.backing
WindowBackingContext Class

public abstract class WindowBackingContext

    extends BackingContext

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 calling BackingContext.getContextFromRequest

Related Topics

BackingContext


Hierarchy
Object
  ControlContext
    BackingContext
      WindowBackingContext
All Implemented Interfaces

Serializable
Direct Known Subclasses

PageBackingContext, PortletBackingContext

Field Summary

public static final String
CLASS_NAME
String
   
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary

 

Method Summary

public Capability
getCapability(Capability capability)

Gets the capability for the Window, may be a state or a mode.

public boolean
getCapabilityVisible(String name)
Gets the visible property for a capability.
public String
getDefinitionId()
Return the definition id of this portlet, page or book.
public String
getDefinitionLabel()
Get the definition label for the portlet/page or book.
public String
getDescription()
Returns the description for the current window.
public String
getInstanceId()
Return the instance id of this portlet.
public abstract String
getLabel()
Return the label for the control.
public String
getOrientation()
Get the orientation of the navigation bar or titlebar of the current window.
public BackingContext
getParentWindowBackingContext()
Get the BackingContext of the parent of the current window.
public String
getPlacementId()
Get the PlacementId for this window.
public WindowMode
getPreviousWindowMode()
Get the previous WindowMode.
public WindowState
getPreviousWindowState()
Get the previous WindowState.
public 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.
public String
getTitle()
Get the title of the window.
public WindowMode
getWindowMode()
Return the current window mode.
public WindowState
getWindowState()
Return the current window state.
public boolean
isCapable(Capability capability)
Determine if this control has the given capability.
public boolean
isPacked()
Get true if the current window is packed.
public void
setCapabilityVisible(String name, boolean isVisible)
Sets the visible property for a capability.
public void
setDescription(String description)
Set window description.
public void
setTitle(String title)

Set the window's title.

public void
setupModeChangeEvent(String modeValue)
Tell the window to change its mode.
public void
setupModeChangeEvent(WindowMode modeValue)
Tell the window to change its mode.
public void
setupPageChangeEvent(String pageLabel)
Tell the window to change the page.
public void
setupStateChangeEvent(String stateValue)
Tell the window to change its state.
 
Methods from  com.bea.netuix.servlets.controls.BackingContext
getChildrenBackingContexts, getParentBackingContext, getTopParentBackingContext, isBackingPhase, isVisible, setBackingPhase, setVisible
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getContextKey, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Field Detail

CLASS_NAME

public static final String CLASS_NAME

 

Constructor Detail


 

Method Detail

getCapability(Capability) Method

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.

Parameters

capability
the Capability to check for.

Returns

The Capability if this Window has it and the user is entitled to use it, otherwise null. Note. this Capability may be cast to a WindowMode or WindowState to get additional information such as mode content uri.

Exceptions

NullPointerException

Related Topics

WindowCapabilities
com.bea.netuix.servlets.controls;.Capability
com.bea.netuix.servlets.controls.window.WindowMode;
com.bea.netuix.servlets.controls.window.WindowState;


getCapabilityVisible(String) Method

public boolean getCapabilityVisible(String name)
throws NullPointerException
Gets the visible property for a capability. name should be the Capability name.

Parameters

name
the Capability name

Returns

is it visible

Exceptions

NullPointerException

getDefinitionId() Method

public String getDefinitionId()
Return the definition id of this portlet, page or book. Note: the definition id is only populated in streaming mode (database, not single file). This can be useful with the persistence API.

Returns

A string representation of the windows defintion id (this is always a number)

getDefinitionLabel() Method

public String getDefinitionLabel()
Get the definition label for the portlet/page or book.

Returns

a String containing the window's definition label.

getDescription() Method

public String getDescription()
Returns the description for the current window.

Returns

description

getInstanceId() Method

public String getInstanceId()
Return the instance id of this portlet. Note: the instance id is only populated when in streaming mode, not single file.

Returns

A string representation of the portlet's instance id (this is always a number)

getLabel() Method

public abstract String getLabel()
Return the label for the control. This will be the instance label for portlets and the definition label for pages and books.

Returns

the label from the book, page or portlet.

getOrientation() Method

public String getOrientation()
Get the orientation of the navigation bar or titlebar of the current window. Value can be top(default), left, right.

Returns

titlebar or navigation bar orientation

getParentWindowBackingContext() Method

public BackingContext getParentWindowBackingContext()
Get the BackingContext of the parent of the current window.

Returns

parent window BackingContext

getPlacementId() Method

public String getPlacementId()
Get the PlacementId for this window.

Returns

PlacementId

Related Topics

PlacementId


getPreviousWindowMode() Method

public WindowMode getPreviousWindowMode()
Get the previous WindowMode.

Returns

WindowMode

getPreviousWindowState() Method

public WindowState getPreviousWindowState()
Get the previous WindowState.

Returns

WindowState

getRenderedChildrenWindowBackingContexts() Method

public 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.

Returns

List of BookBackingContext, WindowBackingContext, and PageBackingContext

getTitle() Method

public String getTitle()
Get the title of the window.


getWindowMode() Method

public WindowMode getWindowMode()
Return the current window mode.

Returns

mode

getWindowState() Method

public WindowState getWindowState()
Return the current window state.

Returns

window state

isCapable(Capability) Method

public boolean isCapable(Capability capability)
Determine if this control has the given capability.

Parameters

capability
- window mode or state

Related Topics

WindowCapabilities


isPacked() Method

public boolean isPacked()
Get true if the current window is packed.

Returns

true if packed

setCapabilityVisible(String, boolean) Method

public void setCapabilityVisible(String name, 
                                 boolean isVisible)
throws NullPointerException
Sets the visible property for a capability. name should be the Capability name. This must be called in the pre-render method or earlier, and is reset upon every new request.

Parameters

name
the Capability name
isVisible
is it visible

Exceptions

NullPointerException

setDescription(String) Method

public void setDescription(String description)
Set window description. Note this method only sets the description for the current request. If you want to set the description permanently (and you are in streaming mode - not single file) then use the PortalCustomizationManager EJB.

Related Topics

IPortletInstanceManager.updatePortletInstance(CustomizationContext, DesktopDefinitionId, PortletInstance)


setTitle(String) Method

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.

Related Topics

IPortletInstanceManager.updatePortletInstance(CustomizationContext, DesktopDefinitionId, PortletInstance)


setupModeChangeEvent(String) Method

public void setupModeChangeEvent(String modeValue)
Tell the window to change its mode. Should only be called during handlePostback.

Parameters

modeValue
the mode to change to

setupModeChangeEvent(WindowMode) Method

public void setupModeChangeEvent(WindowMode modeValue)
Tell the window to change its mode. Should only be called during handlePostback.

Parameters

modeValue
the mode to change to

setupPageChangeEvent(String) Method

public void setupPageChangeEvent(String pageLabel)
Tell the window to change the page. Should only be called during handlePostback.

Parameters

pageLabel
the label of the page to change to

setupStateChangeEvent(String) Method

public void setupStateChangeEvent(String stateValue)
Tell the window to change its state. Should only be called during handlePostback.

Parameters

stateValue
the state to change to