jellytools

Generic jellytools operators which can be used when a specialized operator is not available are:

• NbDialogOperator
• TopComponentOperator
• WizardOperator

The recommended way how to invoke popup or main menu is through an {@link org.netbeans.jellytools.actions.Action} or {@link org.netbeans.jellytools.actions.ActionNoBlock} instance. Predefined actions in this package are descendants either of Action for non blocking operations or of ActionNoBlock for operations which may block further execution by a modal dialog showing.
An action can be performed in "main menu", "popup", "shortcut" or "API" modes. By default it is performed in the first available mode because not every action is defined for all four modes. An example of usage can be:

  // performs in default mode
  new CopyAction().perform();
  // performs in "menu" mode
  new CopyAction().performMenu();

It also possible to specify a node or component on which an action will be performed:

  // selects node first and then performs on it
  new FindAction().perform(myNode);
  // focuses component first and then performs action in "popup" mode
  new FindAction().performPopup(myComponentOperator);

If an action is not predefined, you can create and use your own action.

  // invokes main menu item "Edit|Copy"
  new Action("Edit|Copy", null).perform();
  // invokes popup menu item "Copy" on given node
  new Action(null, "Copy").perform(myNode);

  // invokes main menu item "Edit|Find" (first selects given node)
  new ActionNoBlock("Edit|Find", null).perform(myFolderNode);
  // invoke popup menu item "Find" on given component
  new ActionNoBlock(null, "Find").perform(myEditorOperator);

See package {@link org.netbeans.jellytools.actions actions} for general actions.

If there exist special custom editor for property, there appears small "..." button which invokes such custom editor dialog. Custom editor is embedded in a dialog which contains Default, OK and Cancel buttons, combo box enabling to change editor (e.g. PointEditor/Form Connection). Custom editor operator contains high-level methods to get or set compound property value in one method by custom editor. These methods are then used in tests or in specialized property implementation (see {@link org.netbeans.jellytools.properties}).

Nodes should help to easier testing of nodes in JTree components. The most frequent usage in IDE is in the Projects or Files view but nodes can be used in any component which includes a JTree instance. Nodes are also used as parameters for action's performing.
In this package are predefined specialized nodes for common objects in IDE. You can use them with combination of generic node instances as you like. Simple example looks like this:

  // Finds Source Packages node under My Project node in Projects view
  SourcePackagesNode sourceNode = new Node(new SourcePackagesNode("My Project"));
  // Finds child with given path
  Node node = new Node(sourceNode, "org.netbeans.jellytools.nodes|Node.java");
  // Performs action on node
  new OpenAction().performAPI(node);

Items in a node path are separated by "|" character and searching (exact match, case sensitivity) is driven by current string comparator. Root node must not be included in search path. To get root node instance you need to supply empty search path or use a getter method:

  Node rootNode = new Node(treeOperator, "");

In the IDE properties settings happens through so called property sheets. Property sheet ({@link org.netbeans.jellytools.properties.PropertySheetOperator}) can be docked to any other window. Property sheet consists of JTable with properties and optional description area. The table has two columns showing property name and property value. Properties are grouped to logical categories which can be collapsed or expanded when properties are sorted by category. It is also possible to sort properties alphabetically (Sort by Name). Property value can be changed by inline editors (text field for string values, check box for boolean values - {@link org.netbeans.jellytools.properties.Property#setValue(String)} and combo box for list values - {@link org.netbeans.jellytools.properties.Property#setValue(int)}) or by custom editors where they are available ({@link org.netbeans.jellytools.properties.Property#openEditor}).

You can extend {@link org.netbeans.jellytools.properties.Property Property}, if you want to create your specific property. Some common properties are already created in this package (ColorProperty, PointProperty, ...).

        PropertySheetOperator pso = new PropertySheetOperator("Properties of MyClass");
        Property p = new Property(pso, "Name");
        System.out.println("\nProperty name="+p.getName());
        System.out.println("\nProperty value="+p.getValue());
        p.setValue("ANewValue");
        // set a new value by index where it is applicable
        //p.setValue(2);
        // open custom editor where it is applicable
        //p.openEditor();

If there exist special custom editor for property, there appears small "..." button which invokes such custom editor dialog. Custom editor is embedded in a dialog. If it is property of a component from Form Editor, dialog contains Default, OK and Cancel buttons, combo box enabling to change editor (e.g. PointEditor/Form Connection), button "Advanced" to call "Advanced Initialization Code" dialog (see {@link org.netbeans.jellytools.modules.form.properties.editors}). Otherwise it is dialog with OK and Cancel buttons (Default and Help are optional). A custom editor is extended from  NbDialogOperator. Custom editor operator contains high-level methods to get or set compound property value in one method by custom editor. These methods are then used in tests or in specialized property implementation (see {@link org.netbeans.jellytools.properties}).