cytoscape.visual.customgraphic
Interface CyCustomGraphics

All Known Implementing Classes:

AbstractDCustomGraphics, GradientLayerCustomGraphics, GradientOvalLayer, GradientRoundRectangleLayer, NullCustomGraphics, URLImageCustomGraphics

public interface CyCustomGraphics

Method Summary

String	getDisplayName() Display name is a simple description of this image object.
float	getFitRatio()
int	getHeight() Returns height of current object.
Long	getIdentifier() Immutable session-unique identifier of image generated in constructor.
List<Layer>	getLayers() Get layers belongs to this object.
ObjectPosition	getPosition() Current position
Image	getRenderedImage() From layers of graphics objects, render scaled Image object.
int	getWidth() Returns width of current object.
void	setDisplayName(String displayName) Set human readable display name.
void	setFitRatio(float ratio)
void	setHeight(int height) Set height of Custom Graphics.
void	setPosition(ObjectPosition position) Set posiiton of this graphics.
void	setWidth(int width) Set width of Custom Graphics.

Method Detail

getIdentifier

Long getIdentifier()

Immutable session-unique identifier of image generated in constructor. NOT globally unique. Uniqueness is guaranteed in a session.

Returns:

Immutable ID as Long.

getDisplayName

String getDisplayName()

Display name is a simple description of this image object. May not be unique and mutable.

Returns:

display name as String.

setDisplayName

void setDisplayName(String displayName)

Set human readable display name.

Parameters:

displayName -

getLayers

List<Layer> getLayers()

Get layers belongs to this object. In current Implementation, ti's always Ding's CustomGraphic object. Ordered by Z-Order value.

Returns:

Collection of layer objects (in this version, it's CustomGraphics in Ding)

getWidth

int getWidth()

Returns width of current object.

Returns:

getHeight

int getHeight()

Returns height of current object.

Returns:

setWidth

void setWidth(int width)

Set width of Custom Graphics.

Parameters:

width -

setHeight

void setHeight(int height)

Set height of Custom Graphics.

Parameters:

height -

getFitRatio

float getFitRatio()

setFitRatio

void setFitRatio(float ratio)

getRenderedImage

Image getRenderedImage()

From layers of graphics objects, render scaled Image object. Usually done by Java2D low level code. Usually, the image returned by this method is used in GUI components (as icons).

Returns:

rendered image object.

setPosition

void setPosition(ObjectPosition position)

Set posiiton of this graphics.

Parameters:

position -

getPosition

ObjectPosition getPosition()

Current position

Returns:

position of graphics as ObjectPosition.