org.cytoscape.view.presentation.property

Class NullVisualProperty

java.lang.Object

org.cytoscape.view.model.AbstractVisualProperty<NullDataType>

org.cytoscape.view.presentation.property.NullVisualProperty

All Implemented Interfaces:

VisualProperty<NullDataType>

public final class NullVisualProperty
extends AbstractVisualProperty<NullDataType>

Visual Property for root. This will not be used in actual visualization. Just a marker node in the tree.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't 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: presentation-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>presentation-api</artifactId>
</dependency>

Field Summary

Fields inherited from class org.cytoscape.view.model.AbstractVisualProperty

shouldIgnoreDefault

Constructor Summary

Constructors

Constructor and Description
NullVisualProperty(String id, String displayName) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
NullDataType	parseSerializableString(String text) Returns an object of type T given a string serialized from the getSerializableString(T value) method.
String	toSerializableString(NullDataType value) Returns a string of the specified value suitable for serializing to XML other text output.

Methods inherited from class org.cytoscape.view.model.AbstractVisualProperty

getDefault, getDisplayName, getIdString, getRange, getTargetDataType, shouldIgnoreDefault, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NullVisualProperty

public NullVisualProperty(String id,
                  String displayName)

Constructor.

Parameters:

id - A machine readable string identifying this visual property used for XML serialization.

displayName - A human readable string used for displays and user interfaces.

Method Detail

toSerializableString

public String toSerializableString(NullDataType value)

Description copied from interface: VisualProperty

Returns a string of the specified value suitable for serializing to XML other text output.

Parameters:

value - the specified value.

Returns:

a string of the specified value suitable for serializing to XML other text output.

parseSerializableString

public NullDataType parseSerializableString(String text)

Description copied from interface: VisualProperty

Returns an object of type T given a string serialized from the getSerializableString(T value) method.

Parameters:

text - a string serialized from the getSerializableString(T value) method.

Returns:

an object of type T given a string serialized from the getSerializableString(T value) method.