oracle.ide.model.panels

Class PropertiesDialog

java.lang.Object

oracle.ide.model.panels.PropertiesDialog

public final class PropertiesDialog
extends java.lang.Object

Class for launching a properties dialog based on a HashStructureNode. Examples are the Project Properties dialog and Application Properties dialog.

The best way to register a panel with the PropertiesDialog is through the extension manifest. The parent-refid attribute of the <page> element specifies which dialog the panel is to be added to. For example, the following extension manifest snippet uses "/Project" as the parent-refid, which registers the CoolFeaturePanel for the project properties dialog:

  <extension xmlns="http://jcp.org/jsr/198/extension-manifest"
             id="@@extension.id@@"
             version="@@extension.version@@"
             esdk-version="1.0"
             rsbundle-class="oracle.killerapp.coolfeature.res.Resource">
    <hooks>
      <settings-ui-hook xmlns="http://xmlns.oracle.com/ide/extension">
        <page id="coolFeaturePanel" parent-refid="/Project">
          <label>${COOL_FEATURE_PANEL_LABEL}</label>
          <traversable-class>oracle.killerapp.coolfeature.CoolFeaturePanel</traversable-class>
        </page>
      </settings-ui-hook>
    </hooks>
  </extension>

For registering a panel with the Application properties dialog, use "/Application" as the parent-refid. It is important for the parent-refid to begin with a leading slash in order to get picked up by the extension manifest processing.

Method Summary

Methods

Modifier and Type	Method and Description
static PropertiesDialog	getInstance(java.lang.String internalKey) Each kind of properties dialog is identified by a unique internal key.
boolean	hasPanel() Indicates whether this properties dialog has any panels.
void	showDialog(Context context, java.awt.Frame parent, HashStructureNode node, java.lang.String[] selectionPath) Opens the properties dialog for editing the specified HashStructureNode , using the specified Frame as the parent and setting the dialog's initially selected panel to the one specified by the selectionPath.
void	showDialog(Context context, HashStructureNode node) Opens the properties dialog for editing the specified HashStructureNode , using the specified Frame as the parent and setting the dialog's initially selected panel to the one specified by the selectionPath.
void	showDialog(java.awt.Frame parent, HashStructureNode node, java.lang.String[] selectionPath) Deprecated. since 11.0 use showDialog(Context,Frame,HashStructureNode,String[]).
void	showDialog(HashStructureNode node) Deprecated. since 11.0. Use showDialog(Context,HashStructureNode).

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static final PropertiesDialog getInstance(java.lang.String internalKey)

Each kind of properties dialog is identified by a unique internal key.

Note: Although the parent-refid used in the extension manifest is like "/Project" or "/Application", the internalKey here omits

Parameters:

internalKey - The internal key of the dialog.

Returns:

The dialog configuration.

hasPanel

public final boolean hasPanel()

Indicates whether this properties dialog has any panels.

Returns:

true if this PropertiesDialog has at least one panel registered; false if there are no panels registered.

showDialog

public final void showDialog(HashStructureNode node)

Deprecated. since 11.0. Use showDialog(Context,HashStructureNode).

showDialog

public final void showDialog(Context context,
              HashStructureNode node)

Opens the properties dialog for editing the specified HashStructureNode , using the specified Frame as the parent and setting the dialog's initially selected panel to the one specified by the selectionPath. Each item in the selection path array should be the string label of a node in the tree. So if you want to select the "Options" node in the following tree:

    - General
    - Compiler
      - Java
        - Options
    - Working Sets
  

specify a selection path of: { "Compiler", "Java", "Options" }.

Parameters:

context - the context in which the dialog is being invoked. Passing a valid context is highly recommended. If you do not pass a correct context, a default one will be created using Context.newIdeContext(oracle.ide.model.Node).

node - the node whose properties are being edited. Must not be null.

showDialog

public final void showDialog(java.awt.Frame parent,
              HashStructureNode node,
              java.lang.String[] selectionPath)

Deprecated. since 11.0 use showDialog(Context,Frame,HashStructureNode,String[]).

showDialog

public final void showDialog(Context context,
              java.awt.Frame parent,
              HashStructureNode node,
              java.lang.String[] selectionPath)

Opens the properties dialog for editing the specified HashStructureNode , using the specified Frame as the parent and setting the dialog's initially selected panel to the one specified by the selectionPath. Each item in the selection path array should be the string label of a node in the tree. So if you want to select the "Options" node in the following tree:

    - General
    - Compiler
      - Java
        - Options
    - Working Sets
  

specify a selection path of: { "Compiler", "Java", "Options" }.

Parameters:

context - the context in which the dialog is being invoked. Passing a valid context is highly recommended. If you do not pass a correct context, a default one will be created using Context.newIdeContext(oracle.ide.model.Node).

parent - the parent for the dialog. Must not be null.

node - the node whose properties are being edited. Must not be null.

selectionPath - the selection path.