Class PropertySheetUtil
- java.lang.Object
-
- org.cytoscape.view.vizmap.gui.util.PropertySheetUtil
-
public final class PropertySheetUtil extends Object
Utility class to provide access to basic set of Visual Properties.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 (Static Class): This class is static 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.
-
-
Constructor Summary
Constructors Constructor Description PropertySheetUtil()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
addBasicVisualProperty(VisualProperty<?> vp)
Deprecated.static boolean
isAdvancedMode()
Deprecated.static boolean
isBasic(VisualProperty<?> vp)
Deprecated.static Boolean
isCompatible(VisualProperty<?> vp)
Returns true if given VisualProperty is compatible with current rendering engine.static void
removeIncompatibleVisualProperty(VisualProperty<?> vp)
Remove incompatible VisualProperty from list if new RenderingEngine can handle it.static void
setMode(boolean advanced)
Deprecated.
-
-
-
Method Detail
-
isBasic
@Deprecated public static final boolean isBasic(VisualProperty<?> vp)
Deprecated.Check whether given Visual Property is categorized as Basic or not.- Parameters:
vp
- Visual Property to be checked- Returns:
- true if it is a part of preset basic visual properties.
-
isAdvancedMode
@Deprecated public static final boolean isAdvancedMode()
Deprecated.Check the status of display mode- Returns:
- true if it is in advanced mode.
-
setMode
@Deprecated public static final void setMode(boolean advanced)
Deprecated.Switch the current display mode.- Parameters:
advanced
- If true, it is in advanced mode.
-
addBasicVisualProperty
@Deprecated public static final void addBasicVisualProperty(VisualProperty<?> vp)
Deprecated.Add a new basic visual property. This will be used by Rendering Engine developers.- Parameters:
vp
- New Visual Property to be set as basic set.
-
isCompatible
public static final Boolean isCompatible(VisualProperty<?> vp)
Returns true if given VisualProperty is compatible with current rendering engine.- Parameters:
vp
- VisualProperty to be tested- Returns:
- true if compatible
-
removeIncompatibleVisualProperty
public static final void removeIncompatibleVisualProperty(VisualProperty<?> vp)
Remove incompatible VisualProperty from list if new RenderingEngine can handle it. For example, default rendering engine (ding) is 2D rendering engine and cannot handle Z-coordinate, but if you add 3D renderer, you can remove NODE_DEPTH from the list.- Parameters:
vp
- VisualProperty to be removed from the incompatible list.
-
-