# com.bea.ide.ui.frame
FrameSvc.I Interface

public static interface FrameSvc.I

Enclosing class
  `FrameSvc`

## Method Summary

`public void` | `addForwardingFocusListener`(`JComponent` from, `JComponent` to) Adds a focus listener that will forward focus from the specified JComponent to its first focusable child.
`public void` | `addView`(`String` viewClass, `String` label, boolean visible, boolean focus) Adds a view to the available pool of views, potentially visible and focused.
`public void` | `addView`(`String` viewClass, `String` id, `String` label, boolean visible, boolean focus) Adds a view to the available pool of views, potentially visible and focused.
`public void` | `addView`(`String` viewClass, `FrameSvc.LayoutConstraints` constraints) Adds a view to the available pool of views, potentially visible and focused.
`public void` | `addView`(`String` viewClass, `String` id, `FrameSvc.LayoutConstraints` constraints) Adds a view to the available pool of views, potentially visible and focused.
`public `String`` | `getCurrentLayout`() Gets the layout ID for the currently active layout.
`public `JFrame`` | `getRootFrame`() Returns the main application JFrame.
`public `Object`` | `getViewOwner`(`Component` c) Obtain the view object associated with the given component.
`public boolean` | `isInFloatingWindow`(`Component` c) Determines if the given component is currently located in an undocked window.
`public boolean` | `isViewAdded`(`String` viewClass) Returns true if the specified docking view has been added to the pool of available windows.
`public boolean` | `isViewAdded`(`String` viewClass, `String` id) Returns true if the specified docking view has been added to the pool of available windows.
`public boolean` | `isViewOpen`(`String` viewClass) Returns true if the specified docking view is currently open, even if it is not visible, in an inactive tab.
`public boolean` | `isViewOpen`(`String` viewClass, `String` id) Returns true if the specified docking view is currently open, even if it is not visible, in an inactive tab.
`public boolean` | `isViewVisible`(`String` viewClass) Returns true if the specified docking view is currently visible on screen.
`public boolean` | `isViewVisible`(`String` viewClass, `String` id) Returns true if the specified docking view is currently visible on screen.
`public boolean` | `isWaiting`() Queries whether a wait cursor is currently being displayed.
`public boolean` | `populateViewsMenu`(`IActionContainer` menu, `String` scope, `String` generatorClassName) Populates a menu group with views of a specified scope.
`public void` | `recalcLayout`() Forces the current application layout to check all view availability, and re-layout accordingly.
`public void` | `refresh`() Immediately causes a refresh of the screen.
`public void` | `refresh`(`JComponent` component) Immediately causes a refresh of the component.
`public void` | `removeView`(`String` viewClass) Removes a view for the available pool of views.
`public void` | `removeView`(`String` viewClass, `String` id) Removes a view for the available pool of views.
`public void` | `requestDocumentFocus`() Sets focus to the document pane.
`public void` | `setCurrentLayout`(`String` layoutId) Causes a layout switch based on a layout ID.
`public void` | `setViewVisible`(`String` viewClass, boolean visible, boolean focus) Shows/hides a docking view, and potentially sets focus to it.
`public void` | `setViewVisible`(`String` viewClass, boolean visible)
`public void` | `setViewVisible`(`String` viewClass, `String` id, boolean visible, boolean focus) Shows/hides a docking view, and potentially sets focus to it.
`public void` | `setViewVisible`(`String` viewClass, `String` id, boolean visible)
`public void` | `setWaiting`(boolean waiting) Sets the UI to reflect a wait state (wait cursor).
`public void` | `show`() For use only by the IDE core during startup to show the main JFrame.
`public void` | `showExceptionDialog`(`Throwable` t) Displays a dialog informing the user of a fatal exception, and gives them options for exiting the IDE.

## Method Detail

### addForwardingFocusListener(JComponent, JComponent) Method

    public void addForwardingFocusListener(JComponent from,
                                           JComponent to)

Adds a focus listener that will forward focus from the specified JComponent to its first focusable child.

#### Parameters

from
  component to which focus listener is added

### addView(String, String, boolean, boolean) Method

    public void addView(String viewClass,
                        String label,
                        boolean visible,
                        boolean focus)

Adds a view to the available pool of views, potentially visible and focused. the view will initially appear alone in a floating palette. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute by which this view will be instantiated in the future.

label
  the label used in the UI to identify this window.

Related Topics

``FrameSvc.I.addView(String, String, String, boolean, boolean)``
``FrameSvc.I.addView(String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.addView(String, String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.removeView(String)``
``FrameSvc.I.removeView(String, String)``

### addView(String, String, String, boolean, boolean) Method

    public void addView(String viewClass,
                        String id,
                        String label,
                        boolean visible,
                        boolean focus)

Adds a view to the available pool of views, potentially visible and focused. the view will initially appear alone in a floating palette. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute by which this view will be instantiated in the future.

id
  the 'id' attribute to be specified when requesting the view from IFrameView implementation.

label
  the label used in the UI to identify this window.

Related Topics

``FrameSvc.I.addView(String, String, boolean, boolean)``
``FrameSvc.I.addView(String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.addView(String, String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.removeView(String)``
``FrameSvc.I.removeView(String, String)``

### addView(String, FrameSvc.LayoutConstraints) Method

    public void addView(String viewClass,
                        FrameSvc.LayoutConstraints constraints)

Adds a view to the available pool of views, potentially visible and focused. the view may be fairly precisely placed in the UI using the 'constraints' parameter. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute by which this view will be instantiated in the future.

constraints
  a set of constraints describing how to add this view to the UI.

Related Topics

``FrameSvc.I.addView(String, String, boolean, boolean)``
``FrameSvc.I.addView(String, String, String, boolean, boolean)``
``FrameSvc.I.addView(String, String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.removeView(String)``
``FrameSvc.I.removeView(String, String)``

### addView(String, String, FrameSvc.LayoutConstraints) Method

    public void addView(String viewClass,
                        String id,
                        FrameSvc.LayoutConstraints constraints)

Adds a view to the available pool of views, potentially visible and focused. the view may be fairly precisely placed in the UI using the 'constraints' parameter. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute by which this view will be instantiated in the future.

id
  the 'id' attribute to be specified when requesting the view from IFrameView implementation.

constraints
  a set of constraints describing how to add this view to the UI.

Related Topics

``FrameSvc.I.addView(String, String, boolean, boolean)``
``FrameSvc.I.addView(String, String, String, boolean, boolean)``
``FrameSvc.I.addView(String, FrameSvc.LayoutConstraints)``
``FrameSvc.I.removeView(String)``
``FrameSvc.I.removeView(String, String)``

### getCurrentLayout() Method

    public String getCurrentLayout()

Gets the layout ID for the currently active layout.

Related Topics

``FrameSvc.I.setCurrentLayout(String)``

### getRootFrame() Method

    public JFrame getRootFrame()

Returns the main application JFrame.

### getViewOwner(Component) Method

    public Object getViewOwner(Component c)

Obtain the view object associated with the given component. This will return an IDocumentView, an IFrameView or a Component depending on how the object is defined.

### isInFloatingWindow(Component) Method

    public boolean isInFloatingWindow(Component c)

Determines if the given component is currently located in an undocked window.

### isViewAdded(String) Method

    public boolean isViewAdded(String viewClass)

Returns true if the specified docking view has been added to the pool of available windows.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

### isViewAdded(String, String) Method

    public boolean isViewAdded(String viewClass,
                               String id)

Returns true if the specified docking view has been added to the pool of available windows.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

id
  the 'id' attribute from the view-frame declaration

### isViewOpen(String) Method

    public boolean isViewOpen(String viewClass)

Returns true if the specified docking view is currently open, even if it is not visible, in an inactive tab.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.isViewVisible(String)``

### isViewOpen(String, String) Method

    public boolean isViewOpen(String viewClass,
                              String id)

Returns true if the specified docking view is currently open, even if it is not visible, in an inactive tab.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

id
  the 'id' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.isViewVisible(String, String)``

### isViewVisible(String) Method

    public boolean isViewVisible(String viewClass)

Returns true if the specified docking view is currently visible on screen.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.setViewVisible(String, boolean, boolean)``
``FrameSvc.I.isViewOpen(String)``

### isViewVisible(String, String) Method

    public boolean isViewVisible(String viewClass,
                                 String id)

Returns true if the specified docking view is currently visible on screen.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

id
  the 'id' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.setViewVisible(String, boolean, boolean)``
``FrameSvc.I.isViewOpen(String, String)``

### isWaiting() Method

    public boolean isWaiting()

Queries whether a wait cursor is currently being displayed.

Related Topics

``FrameSvc.I.setWaiting(boolean)``

### populateViewsMenu(IActionContainer, String, String) Method

    public boolean populateViewsMenu(IActionContainer menu,
                                     String scope,
                                     String generatorClassName)

Populates a menu group with views of a specified scope. used by menu generators.

### recalcLayout() Method

    public void recalcLayout()

Forces the current application layout to check all view availability, and re-layout accordingly. If executed on a background thread, this function will have no effect until it can execute on the event thread.

### refresh() Method

    public void refresh()

Immediately causes a refresh of the screen.

### refresh(JComponent) Method

    public void refresh(JComponent component)

Immediately causes a refresh of the component.

### removeView(String) Method

    public void removeView(String viewClass)

Removes a view for the available pool of views. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

### removeView(String, String) Method

    public void removeView(String viewClass,
                           String id)

Removes a view for the available pool of views. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

### requestDocumentFocus() Method

    public void requestDocumentFocus()

Sets focus to the document pane.

### setCurrentLayout(String) Method

    public void setCurrentLayout(String layoutId)

Causes a layout switch based on a layout ID. If the layout has associated 'application-layout' information from loading the extension.xml files, then this layout is loaded. Otherwise the existing layout is used. All layouts initiated in this way are persisted to user preferences, and restored complete with user modifications on subsequent layout loads. The only layouts currently supported are "main" and "urn:com-bea-ide:debug".

Related Topics

``FrameSvc.I.getCurrentLayout()``

### setViewVisible(String, boolean, boolean) Method

    public void setViewVisible(String viewClass,
                               boolean visible,
                               boolean focus)

Shows/hides a docking view, and potentially sets focus to it. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.isViewVisible(String)``

### setViewVisible(String, boolean) Method

    public void setViewVisible(String viewClass,
                               boolean visible)

### setViewVisible(String, String, boolean, boolean) Method

    public void setViewVisible(String viewClass,
                               String id,
                               boolean visible,
                               boolean focus)

Shows/hides a docking view, and potentially sets focus to it. If executed on a background thread, this function will have no effect until it can execute on the event thread.

#### Parameters

viewClass
  the 'class' attribute from the view-frame declaration

id
  the 'id' attribute from the view-frame declaration

Related Topics

``FrameSvc.I.isViewVisible(String)``

### setViewVisible(String, String, boolean) Method

    public void setViewVisible(String viewClass,
                               String id,
                               boolean visible)

### setWaiting(boolean) Method

    public void setWaiting(boolean waiting)

Sets the UI to reflect a wait state (wait cursor). Calls that set wait state to true, must ensure that the wait state is returned to false, or else the UI will not respond. There should be a try/finally that insures waiting is set back to false. This is ref-counted, so if setWaiting(true) is called 3 times, the wait cursor will not go away until the third call to setWaiting(false).

### show() Method

    public void show()

For use only by the IDE core during startup to show the main JFrame.

### showExceptionDialog(Throwable) Method

    public void showExceptionDialog(Throwable t)

Displays a dialog informing the user of a fatal exception, and gives them options for exiting the IDE. This method should be used for errors that are unlikely to be recovered from or that represent a serious problem that needs to be reported.