javax.ide.view
Class GUIPanel

java.lang.Object
  javax.ide.view.GUIPanel

public final class GUIPanel
extends java.lang.Object

A GUIPanel opaquely encapsulates the gui panel that is to be hosted by an IDE's service such as: the IDE preferences panel, the editor's panel, etc.. There are two components in a GUI component hierarchy that need to be identified: the root component, and the focusable component. The root component will be added to the children list of the IDE host, and the focusable component will be given the focus when the IDE host becomes active. For Swing based IDE's the type of the root and focusable components should be: JComponent.

Constructor Summary

GUIPanel(java.lang.Object root)
Constructor.

GUIPanel(java.lang.Object root, java.lang.Object focusable)
Constructor.

Method Summary

java.lang.Object	getFocusableComponent() Get the component that can take input focus in the component hierarchy of the encapsulated panel.
java.lang.Object	getRootComponent() Get the root component in the component hierarchy of the panel encapsulated by this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GUIPanel

public GUIPanel(java.lang.Object root,
                java.lang.Object focusable)

Constructor.

Parameters:

root - The root component in the hierarchy of the panel encapsulated by this class.

focusable - The component that can take focus.

GUIPanel

public GUIPanel(java.lang.Object root)

Constructor.

Parameters:

root - The root component in the hierarchy of the panel encapsulated by this class.

Method Detail

getRootComponent

public java.lang.Object getRootComponent()

Get the root component in the component hierarchy of the panel encapsulated by this class.

Returns:

The root component in the hierarchy.

getFocusableComponent

public java.lang.Object getFocusableComponent()

Get the component that can take input focus in the component hierarchy of the encapsulated panel.

Returns:

The component that can take input focus.