org.ginsim.core.graph.view.style

Interface Style

All Known Subinterfaces:

EdgeStyle<V,E>, NodeStyle<V>

All Known Implementing Classes:

BaseStyle, BaseStyleOverride, DefaultDynamicEdgeStyle, DefaultDynamicNodeStyle, DefaultHTGNodeStyle, DefaultRegulatoryEdgeStyle, DefaultRegulatoryNodeStyle, DefaultTreeEdgeStyle, DefaultTreeNodeStyle, EdgeStyleImpl, EdgeStyleOverride, NodeStyleImpl, NodeStyleOverride

public interface Style

Define common methods for styles.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
void	copy(Style source) Copy properties from an existing style.
String	getCSS() define the style as CSS rules.
String	getName()
Style	getParent()
Object	getParentProperty(StyleProperty property)
StyleProperty[]	getProperties() Retrieve all properties used by this style.
Object	getProperty(StyleProperty prop) Retrieve the value of a property.
void	setName(String name)
void	setProperty(StyleProperty prop, Object value) Assign a value to a property.

Method Detail

getProperties

StyleProperty[] getProperties()

Retrieve all properties used by this style. The default set of properties matches visual properties, but each style can use a different set of properties. For example, the default style for edges in a regulatory graph has several properties for edge colors: positive, negative, dual.

Returns:

the list of properties used by this style.

getProperty

Object getProperty(StyleProperty prop)

Retrieve the value of a property. This handles internal properties directly and should not be used to retrieve the resulting visual settings (use dedicated methods for that). This should be used to save properties, or for the style edition panel.

Parameters:

prop - the property to retrieve

Returns:

the value of the property, which can be null.

setProperty

void setProperty(StyleProperty prop,
                 Object value)

Assign a value to a property. This handles internal properties directly. It should be used to restore them when loading a graph or for the style edition panel.

Parameters:

prop - the property to set

value - the assigned value (can be null)

getName

String getName()

setName

void setName(String name)

getParentProperty

Object getParentProperty(StyleProperty property)

getCSS

String getCSS()

define the style as CSS rules.

Returns:

a String with the CSS rules

copy

void copy(Style source)

Copy properties from an existing style.

Parameters:

source -

getParent

Style getParent()