Package org.cytoscape.view.vizmap.gui.editor

Class AbstractVisualPropertyEditor<T>

java.lang.Object

org.cytoscape.view.vizmap.gui.editor.AbstractVisualPropertyEditor<T>

Type Parameters:

T - The generic type of this AbstractVisualPropertyEditor.

All Implemented Interfaces:

VisualPropertyEditor<T>

public abstract class AbstractVisualPropertyEditor<T>
extends Object
implements VisualPropertyEditor<T>

Abstract implementation of Visual Property Editor. All editors should extend this class.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: vizmap-gui-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>vizmap-gui-api</artifactId>
</dependency>

Field Summary

Fields

Modifier and Type	Field	Description
protected TableCellRenderer	discreteTableCellRenderer	The cell renderer for discrete mappings.
protected final PropertyEditor	propertyEditor	The property editor.

Constructor Summary

Constructors

Constructor	Description
AbstractVisualPropertyEditor(Class<T> type, PropertyEditor propertyEditor, ContinuousEditorType continuousEditorType, ContinuousMappingCellRendererFactory cellRendererFactory)	Creates a new AbstractVisualPropertyEditor object.

Method Summary

Modifier and Type	Method	Description
ContinuousEditorType	getContinuousEditorType()	Returns type of Continuous Editor.
TableCellRenderer	getContinuousTableCellRenderer(ContinuousMappingEditor<? extends Number,T> continuousMappingEditor)	A custom cell renderer for Continuous table cells.
Icon	getDefaultIcon(int width, int height)	This is for default view editor.
TableCellRenderer	getDiscreteTableCellRenderer()	A custom cell renderer for Discrete table cells.
PropertyEditor	getPropertyEditor()	Returns PropertyEditor object for this data type.
Class<T>	getType()	Returns the type of object managed in the Visual property.

Methods inherited from class java.lang.Object

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

Field Details

propertyEditor

protected final PropertyEditor propertyEditor

The property editor.

discreteTableCellRenderer

protected TableCellRenderer discreteTableCellRenderer

The cell renderer for discrete mappings.

Constructor Details

AbstractVisualPropertyEditor

public AbstractVisualPropertyEditor(Class<T> type,
 PropertyEditor propertyEditor,
 ContinuousEditorType continuousEditorType,
 ContinuousMappingCellRendererFactory cellRendererFactory)

Creates a new AbstractVisualPropertyEditor object.

Parameters:

type - The type of this property editor.

propertyEditor - the PropertyEditor to construct this with.

continuousEditorType - the ContinuousEditorType to construct this with.

Method Details

getType

public Class<T> getType()

Description copied from interface: VisualPropertyEditor

Returns the type of object managed in the Visual property.

Specified by:

getType in interface VisualPropertyEditor<T>

Returns:

the type of object managed in the Visual property.

getPropertyEditor

public PropertyEditor getPropertyEditor()

Description copied from interface: VisualPropertyEditor

Returns PropertyEditor object for this data type.

Specified by:

getPropertyEditor in interface VisualPropertyEditor<T>

Returns:

PropertyEditor object for this data type.

getDiscreteTableCellRenderer

public TableCellRenderer getDiscreteTableCellRenderer()

Description copied from interface: VisualPropertyEditor

A custom cell renderer for Discrete table cells.

Specified by:

getDiscreteTableCellRenderer in interface VisualPropertyEditor<T>

Returns:

a TableCellRenderer Discrete table cells.

getContinuousTableCellRenderer

public TableCellRenderer getContinuousTableCellRenderer(ContinuousMappingEditor<? extends Number,T> continuousMappingEditor)

Description copied from interface: VisualPropertyEditor

A custom cell renderer for Continuous table cells.

Specified by:

getContinuousTableCellRenderer in interface VisualPropertyEditor<T>

Returns:

a TableCellRenderer Continuous table cells.

getContinuousEditorType

public ContinuousEditorType getContinuousEditorType()

Description copied from interface: VisualPropertyEditor

Returns type of Continuous Editor.

Specified by:

getContinuousEditorType in interface VisualPropertyEditor<T>

Returns:

type of ContinuousMappingEditor

getDefaultIcon

public Icon getDefaultIcon(int width,
 int height)

Description copied from interface: VisualPropertyEditor

This is for default view editor.

Specified by:

getDefaultIcon in interface VisualPropertyEditor<T>

Parameters:

width - The width of the desired Icon.

height - The height of the desired Icon.

Returns:

An icon of the specified width and height.