org.netbeans.spi.viewmodel

Class Models

java.lang.Object

org.netbeans.spi.viewmodel.Models

public final class Models
extends Object

Contains various utility methods for various models.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Models.ActionPerformer Support interface for createAction(String,Models.ActionPerformer,int) method.
static class	Models.CompoundModel This model encapsulates all currently supported models.
static class	Models.TreeFeatures Tree expansion control.

Field Summary

Fields

Modifier and Type	Field and Description
static Models.CompoundModel	EMPTY_MODEL Empty model - returns default root node with no children.
static int	MULTISELECTION_TYPE_ALL
static int	MULTISELECTION_TYPE_ANY
static int	MULTISELECTION_TYPE_EXACTLY_ONE

Constructor Summary

Constructors

Constructor and Description
Models()

Method Summary

Modifier and Type	Method and Description
static Action	createAction(String displayName, Models.ActionPerformer performer, int multiselectionType) Returns Action for given parameters.
static Models.CompoundModel	createCompoundModel(List models) Creates one Models.CompoundModel from given list of models.
static Models.CompoundModel	createCompoundModel(List models, String propertiesHelpID) Creates one Models.CompoundModel from given list of models.
static Node	createNodes(Models.CompoundModel compoundModel, TreeView treeView) Creates a root node of the nodes tree structure for given Models.CompoundModel.
static JComponent	createView(Models.CompoundModel compoundModel) Creates a new instance of TreeTableView for given Models.CompoundModel.
static void	setModelsToView(JComponent view, Models.CompoundModel compoundModel) Set given models to given view instance.
static Models.TreeFeatures	treeFeatures(JComponent view) Returns implementation of tree view features for given view.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_MODEL

public static Models.CompoundModel EMPTY_MODEL

Empty model - returns default root node with no children.

MULTISELECTION_TYPE_EXACTLY_ONE

public static int MULTISELECTION_TYPE_EXACTLY_ONE

MULTISELECTION_TYPE_ALL

public static int MULTISELECTION_TYPE_ALL

MULTISELECTION_TYPE_ANY

public static int MULTISELECTION_TYPE_ANY

Constructor Detail

Models

public Models()

Method Detail

createView

public static JComponent createView(Models.CompoundModel compoundModel)

Creates a new instance of TreeTableView for given Models.CompoundModel.

Parameters:

compoundModel - a compound model instance

Returns:

new instance of complete model view

createNodes

public static Node createNodes(Models.CompoundModel compoundModel,
                               TreeView treeView)

Creates a root node of the nodes tree structure for given Models.CompoundModel.

Parameters:

compoundModel - a compound model instance

treeView - The tree view component where nodes are going to be displayed.

Returns:

new instance root node

Since:

1.15

setModelsToView

public static void setModelsToView(JComponent view,
                                   Models.CompoundModel compoundModel)

Set given models to given view instance.

Parameters:

view - a view instance - must be an instance created by createView(org.netbeans.spi.viewmodel.Models.CompoundModel) method.

compoundModel - a compound model instance

createCompoundModel

public static Models.CompoundModel createCompoundModel(List models)

Creates one Models.CompoundModel from given list of models.

If this list does not include any instance of TreeModel or TreeExpansionModel, a default implementation of these models is created based on the instance of this list. Thus you get one implementation per provided instance of the models list.

Parameters:

models - a list of models

Returns:

Models.CompoundModel encapsulating given list of models

createCompoundModel

public static Models.CompoundModel createCompoundModel(List models,
                                                       String propertiesHelpID)

Creates one Models.CompoundModel from given list of models.

If this list does not include any instance of TreeModel or TreeExpansionModel, a default implementation of these models is created based on the instance of this list. Thus you get one implementation per provided instance of the models list.

Parameters:

models - a list of models

propertiesHelpID - The help ID, which is set for the properties sheets created from this model.

Returns:

Models.CompoundModel encapsulating given list of models

Since:

1.7

createAction

public static Action createAction(String displayName,
                                  Models.ActionPerformer performer,
                                  int multiselectionType)

Returns Action for given parameters.

Parameters:

displayName - a display name for action

performer - a performer for action

multiselectionType - The type of the multi selection - one of the MULTISELECTION_TYPE_* constants.

Returns:

a new instance of Action for given parameters

treeFeatures

public static Models.TreeFeatures treeFeatures(JComponent view)
                                        throws UnsupportedOperationException

Returns implementation of tree view features for given view.

Parameters:

view - a view created by this Models class

Returns:

implementation of tree view features

Throws:

UnsupportedOperationException - in the case that given view is not tree view