org.cytoscape.view.vizmap.gui.editor

Interface VisualPropertyEditor<T>

Type Parameters:

T - Type of object managed in the Visual Prop.

All Known Implementing Classes:

AbstractVisualPropertyEditor

public interface VisualPropertyEditor<T>

Facade of all editor-related objects for a Visual Property. If an app developer adds a custom visual property, they should implement this in the presentation layer.

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>

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary

Modifier and Type	Method and 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.

Method Detail

getType

Class<T> getType()

Returns the type of object managed in the Visual property.

Returns:

the type of object managed in the Visual property.

getContinuousEditorType

ContinuousEditorType getContinuousEditorType()

Returns type of Continuous Editor.

Returns:

type of ContinuousMappingEditor

getPropertyEditor

PropertyEditor getPropertyEditor()

Returns PropertyEditor object for this data type.

Returns:

PropertyEditor object for this data type.

getDiscreteTableCellRenderer

TableCellRenderer getDiscreteTableCellRenderer()

A custom cell renderer for Discrete table cells.

Returns:

a TableCellRenderer Discrete table cells.

getContinuousTableCellRenderer

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

A custom cell renderer for Continuous table cells.

Returns:

a TableCellRenderer Continuous table cells.

getDefaultIcon

Icon getDefaultIcon(int width,
                    int height)

This is for default view editor.

Parameters:

width - The width of the desired Icon.

height - The height of the desired Icon.

Returns:

An icon of the specified width and height.