# com.bea.netuix.servlets.controls.application.backing
DesktopBackingContext Class

public class DesktopBackingContext
extends `BackingContext`

The `DesktopBackingContext` is used to interact with the underlying Desktop control. This is the BackingContext for a Desktop. This `BackingContext` can only be referenced from a backing file. If you think you need to reference this from a JSP you should look at `DesktopPresentationContext`.

To get a handle to the BackingContext just call the following:
DesktopBackingContext.getDesktopBackingContext(request); Note: most methods for retrieving child contexts do not work if called from the `init()` method of a backing file. This is because the tree has not been fully initialized. You may have to call the method from the `preRender()` or `handlePostbackData` method.

Hierarchy
  `Object`
  `ControlContext`
  `BackingContext`
  `DesktopBackingContext`

All Implemented Interfaces
  `Serializable`

## Field Summary

`protected static final `String`` | `CLASS_NAME` String

Fields from com.bea.netuix.servlets.controls`.`ControlContext``
`debug`

## Constructor Summary

## Method Summary

`public `BookBackingContext`` | `getBookBackingContext`() Retrieve the main book (top level) backing context.
`public `BookBackingContext`` | `getBookBackingContextRecursive`(`String` definitionLabel) Return a book searching the entire tree recursively.
`public `String`` | `getDefinitionLabel`() Get definition label as defined in the portal file.
`public static `DesktopBackingContext`` | `getDesktopBackingContext`(`HttpServletRequest` request) Obtain a reference to the current `DesktopBackingContext` in the request.
`public `LookAndFeelDefinitionId`` | `getLookAndFeelDefinitionId`() Return the look and feel definition id.
`public `String`` | `getLookAndFeelDefinitionLabel`() Return the look and feel definition label.
`public `PageBackingContext`` | `getPageBackingContextRecursive`(`String` definitionLabel) Return a book or a page but traverse the entire tree, this will go inside books that are on pages too.
`public `PortletBackingContext`` | `getPortletBackingContextRecursive`(`String` instanceLabel) Return the portlet backing context matching the supplied instance label.
`public `PortletBackingContext`[]` | `getPortletsBackingContextRecursive`(`String` definitionLabel) Return portlet backing contexts matching the supplied definition label.
`public `String`` | `getTitle`() Get the internationalized title for this desktop.
`public void` | `setTitle`(`String` title) Set a temporary value for the title.

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

    protected static final String CLASS_NAME

## Constructor Detail

## Method Detail

### getBookBackingContext() Method

    public BookBackingContext getBookBackingContext()

Retrieve the main book (top level) backing context.

#### Returns

a reference to the main book backing context otherwise null if none exist.

### getBookBackingContextRecursive(String) Method

    public BookBackingContext getBookBackingContextRecursive(String definitionLabel)

Return a book searching the entire tree recursively. If you are interested in both books AND pages use `getPageBackingContextRecursive()` as that method returns both. Note: this method may return null if called from the init() method of a backing context.

#### Parameters

definitionLabel
  of the book

#### Returns

the Book of interest or null if not found.

### getDefinitionLabel() Method

    public String getDefinitionLabel()

Get definition label as defined in the portal file.

### getDesktopBackingContext(HttpServletRequest) Method

    public static DesktopBackingContext getDesktopBackingContext(HttpServletRequest request)

Obtain a reference to the current `DesktopBackingContext` in the request. Note: the DesktopBackingContext should only be obtained from a backing file. If you think you need this context from a JSP look at DesktopPresentationContext.

#### Parameters

request
  http servlet request.

#### Returns

a refence to the DesktopBackingContext or null if none exist.

### getLookAndFeelDefinitionId() Method

    public LookAndFeelDefinitionId getLookAndFeelDefinitionId()

Return the look and feel definition id. This method will only work for stremed portals.

#### Returns

look and feel definition id or null if portal file.

### getLookAndFeelDefinitionLabel() Method

    public String getLookAndFeelDefinitionLabel()

Return the look and feel definition label.

#### Returns

look and feel definition label as defined by the developer.

### getPageBackingContextRecursive(String) Method

    public PageBackingContext getPageBackingContextRecursive(String definitionLabel)

Return a book or a page but traverse the entire tree, this will go inside books that are on pages too. Note: this method may return null if called from the init() method of a backing context.

#### Returns

pageBackingContext or (BookBackingContext if book) of the page or book with matching definition label.

### getPortletBackingContextRecursive(String) Method

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

#### Parameters

instanceLabel
  unique instance label of the portlet

#### Returns

a reference to the portlet's BackingContext if it exist otherwise null.

### getPortletsBackingContextRecursive(String) Method

    public PortletBackingContext[] getPortletsBackingContextRecursive(String definitionLabel)

Return portlet backing contexts matching the supplied definition label. Since many portlets can share the same definition label, more then one portlet can be returned. If you are interested in just one portlet then try `getPortletBackingContextRecursive(String instanceLabel)` Note: this method may return null if called from the init() method of a backing context.

#### Parameters

definitionLabel
  label of the portlet

#### Returns

a non null array of PortletBackingContext.

### getTitle() Method

    public String getTitle()

Get the internationalized title for this desktop.

#### Returns

a non null title for this desktop.

### setTitle(String) Method

    public void setTitle(String title)

Set a temporary value for the title.