Skip navigation links
org.netbeans.spi.viewmodel/2 1.53.1

Package org.netbeans.spi.viewmodel

Defines API for sharing of Tree Table View.

See: Description

Package org.netbeans.spi.viewmodel Description

Defines API for sharing of Tree Table View. This API has been designed for sharing Debugger Views (like Callstack View) among different modules. But it does not depends on debugger itself.

Main features:

How to use View Model API

Following example shows how to use viewmodel API to create simple files view.

Step 1.

In the first step we should create plain tree model (TreeModel).
public class TreeModelImpl implements TreeModel {
Tree Model Example 1
public Object getRoot () {
return ROOT;
}

public Object[] getChildren (Object parent, int from, int to) {
if (parent == ROOT)
return File.listRoots ();
return ((File) parent).listFiles ();
}

public boolean isLeaf (Object node) {
if (node == ROOT)
return false;
return ((File) node).isFile ();
}
}
And create a TreeView for this model:
    JComponent treeView = Models.createView (
Models.createCompoundModel (
Arrays.asList (new Model[] {
new TreeModelImpl (), // TreeModel
new ArrayList () // list of ColumnModel s
})
)
);

Step 2.

NodeModel implementation can define name, icon and tooltip for tree nodes produced by TreeModel.
public class NodeModelImpl implements NodeModel {Tree Model Example 2

public String getDisplayName (Object node) {
if (node == ROOT) return "Name";
String name = ((File) node).getName ();
if (name.length () < 1) return ((File) node).getAbsolutePath ();
return name;
}

public String getIconBase (Object node) {
if (node == ROOT) return "folder";
if (((File) node).isDirectory ()) return "folder";
return "file";
}

public String getShortDescription (Object node) {
if (node == ROOT) return "Name";
return ((File) node).getAbsolutePath ();
}
}

Step 3.

NodeActionsProvider defines set of Actions for each node, and default action..
public class NodeActionsProviderImpl implements NodeActionsProvider {

public Action[] getActions (final Object node) {
return new Action [] {
new AbstractAction ("Open") {
public void actionPerformed (ActionEvent e) {
performDefaultAction (node);
}
},
new AbstractAction ("Delete") {
public void actionPerformed (ActionEvent e) {
((File) node).delete ();
}
}
};
}

public void performDefaultAction (Object node) {
try {
JFrame f = new JFrame ("View");
f.getContentPane ().add (new JEditorPane (((File) node).toURL ()));
f.pack ();
f.show ();
} catch (Exception e) {
e.printStackTrace();
}
}
}

Tree Model Example 3

Step 4.

TableModel and ColumnModel adds support for additional columns to tree view.
public class TableModelImpl implements TableModel {


public Object getValueAt (Object node, String columnID) {
try {
if (node == ROOT) return null;
if (columnID.equals ("sizeID")) {
if (((File) node).isDirectory ()) return "<dir>";
return "" + new FileInputStream ((File) node).getChannel ().size ();
}
} catch (Exception e) {
e.printStackTrace ();
}
return "";
}

public boolean isReadOnly (Object node, String columnID) {
return true;
}

public void setValueAt (Object node, String columnID, Object value) {
}
}
And initialization of columns looks like:
    ArrayList columns = new ArrayList ();Tree Model Example 4
columns.add (new ColumnModel () {
public String getID () { return "sizeID"; }
public String getDisplayName () { return "size"; }
public Class getType () { return String.class; }
});
JComponent treeTableView = Models.createView (
Models.createCompoundModel (
Arrays.asList (new Model[] {
new TreeModelImpl (), // TreeModel
new NodeModelImpl (), // NodeModel
new TableModelImpl (), // TableModel
new NodeActionsProviderImpl (), // NodeActionsProvider
columns // list of ColumnModel s
})
)
);




How to use Filters

We can use filters to modify content of tree table view created in our example.
All these actions can be done in some external module.

Skip navigation links
org.netbeans.spi.viewmodel/2 1.53.1

Built on June 22 2019.  |   Copyright © 2017-2019 Apache Software Foundation. All Rights Reserved.