Cytoscape 2.8.0 API

giny.view
Interface EdgeView

All Known Subinterfaces:
CyEdgeView

public interface EdgeView


Field Summary
static int BLACK_ARROW
           
static int BLACK_CIRCLE
           
static int BLACK_DELTA
           
static int BLACK_DIAMOND
           
static int BLACK_T
           
static int CURVED_LINES
          Draws splined curves for edges.
static int EDGE_COLOR_ARROW
           
static int EDGE_COLOR_CIRCLE
           
static int EDGE_COLOR_DELTA
           
static int EDGE_COLOR_DIAMOND
           
static int EDGE_COLOR_T
           
static int EDGE_HALF_ARROW_BOTTOM
           
static int EDGE_HALF_ARROW_TOP
           
static int NO_END
           
static int STRAIGHT_LINES
          Draws straight lines for edges.
static int WHITE_ARROW
           
static int WHITE_CIRCLE
           
static int WHITE_DELTA
           
static int WHITE_DIAMOND
           
static int WHITE_T
           
 
Method Summary
 void clearBends()
           
 void drawSelected()
          Draws the edge as red and draws any handles previously added.
 void drawUnselected()
          Draws the edge as black and removes any handles from the display.
 Bend getBend()
           
 Edge getEdge()
           
 int getEdgeLabelAnchor()
           
 int getGraphPerspectiveIndex()
           
 GraphView getGraphView()
           
 Label getLabel()
           
 double getLabelOffsetX()
           
 double getLabelOffsetY()
           
 double getLabelWidth()
           
 int getLineType()
           
 int getRootGraphIndex()
           
 boolean getSelected()
           
 Paint getSelectedPaint()
          This really refers to the Stroke, TODO: Make separte stroke methods
 int getSourceEdgeEnd()
          Return the Drawing style for the edge end.
 Paint getSourceEdgeEndPaint()
           
 Paint getSourceEdgeEndSelectedPaint()
           
 Stroke getStroke()
           
 float getStrokeWidth()
           
 int getTargetEdgeEnd()
          REturn the Drawing style for the edge end.
 Paint getTargetEdgeEndPaint()
           
 Paint getTargetEdgeEndSelectedPaint()
           
 Paint getUnselectedPaint()
          This really refers to the Stroke, TODO: Make separte stroke methods
 boolean isHidden()
           
 boolean isSelected()
           
 void select()
           
 void setEdgeLabelAnchor(int position)
           
 void setLabelOffsetX(double x)
           
 void setLabelOffsetY(double y)
           
 void setLabelWidth(double width)
           
 void setLineType(int line_type)
           
 boolean setSelected(boolean state)
          When we are selected then we draw ourselves red, and draw any handles.
 void setSelectedPaint(Paint paint)
          This really refers to the Stroke, TODO: Make separte stroke methods
 void setSourceEdgeEnd(int type)
          Sets the Drawing style for the edge end.
 void setSourceEdgeEndPaint(Paint paint)
           
 void setSourceEdgeEndSelectedPaint(Paint paint)
           
 void setSourceEdgeEndStrokePaint(Paint paint)
           
 void setStroke(Stroke stroke)
           
 void setStrokeWidth(float width)
           
 void setTargetEdgeEnd(int type)
          Sets the Drawing style for the edge end.
 void setTargetEdgeEndPaint(Paint paint)
           
 void setTargetEdgeEndSelectedPaint(Paint paint)
           
 void setTargetEdgeEndStrokePaint(Paint paint)
           
 void setToolTip(String tip)
          Sets what the tooltip will be for this EdgeView
 void setUnselectedPaint(Paint paint)
          This really refers to the Stroke, TODO: Make separte stroke methods
 void unselect()
           
 void updateEdgeView()
          This is the main method called to update the drawing of the edge.
 void updateLine()
          Draws the Edge
 void updateSourceArrow()
          Draws the EdgeEnd, also sets the Source/Target Points to values such that the edge does not "go through" the end
 void updateTargetArrow()
          Draws the EdgeEnd, also sets the Source/Target Points to values such that the edge does not "go through" the end
 

Field Detail

CURVED_LINES

static final int CURVED_LINES
Draws splined curves for edges.

See Also:
Constant Field Values

STRAIGHT_LINES

static final int STRAIGHT_LINES
Draws straight lines for edges.

See Also:
Constant Field Values

NO_END

static final int NO_END
See Also:
Constant Field Values

WHITE_DELTA

static final int WHITE_DELTA
See Also:
Constant Field Values

BLACK_DELTA

static final int BLACK_DELTA
See Also:
Constant Field Values

EDGE_COLOR_DELTA

static final int EDGE_COLOR_DELTA
See Also:
Constant Field Values

WHITE_ARROW

static final int WHITE_ARROW
See Also:
Constant Field Values

BLACK_ARROW

static final int BLACK_ARROW
See Also:
Constant Field Values

EDGE_COLOR_ARROW

static final int EDGE_COLOR_ARROW
See Also:
Constant Field Values

WHITE_DIAMOND

static final int WHITE_DIAMOND
See Also:
Constant Field Values

BLACK_DIAMOND

static final int BLACK_DIAMOND
See Also:
Constant Field Values

EDGE_COLOR_DIAMOND

static final int EDGE_COLOR_DIAMOND
See Also:
Constant Field Values

WHITE_CIRCLE

static final int WHITE_CIRCLE
See Also:
Constant Field Values

BLACK_CIRCLE

static final int BLACK_CIRCLE
See Also:
Constant Field Values

EDGE_COLOR_CIRCLE

static final int EDGE_COLOR_CIRCLE
See Also:
Constant Field Values

WHITE_T

static final int WHITE_T
See Also:
Constant Field Values

BLACK_T

static final int BLACK_T
See Also:
Constant Field Values

EDGE_COLOR_T

static final int EDGE_COLOR_T
See Also:
Constant Field Values

EDGE_HALF_ARROW_TOP

static final int EDGE_HALF_ARROW_TOP
See Also:
Constant Field Values

EDGE_HALF_ARROW_BOTTOM

static final int EDGE_HALF_ARROW_BOTTOM
See Also:
Constant Field Values
Method Detail

getGraphPerspectiveIndex

int getGraphPerspectiveIndex()
Returns:
the index of this edge in the GraphPerspective

getRootGraphIndex

int getRootGraphIndex()
Returns:
the index of this edge in the RootGraph

getEdge

Edge getEdge()
Returns:
the Edge to which we are a view on

getGraphView

GraphView getGraphView()
Returns:
the GraphView we are in

setStrokeWidth

void setStrokeWidth(float width)
Parameters:
width - set a new line width for this edge

getStrokeWidth

float getStrokeWidth()
Returns:
the currently set edge width

setStroke

void setStroke(Stroke stroke)
Parameters:
stroke - the stroke to use on this edge

getStroke

Stroke getStroke()
Returns:
the stroke used on this edge

setLineType

void setLineType(int line_type)
Parameters:
line_type - set a new line type for the edge

getLineType

int getLineType()
Returns:
the currently set edge line type

setUnselectedPaint

void setUnselectedPaint(Paint paint)
This really refers to the Stroke, TODO: Make separte stroke methods

Parameters:
paint - the paint for this node

getUnselectedPaint

Paint getUnselectedPaint()
This really refers to the Stroke, TODO: Make separte stroke methods

Returns:
the currently set edge Paint

setSelectedPaint

void setSelectedPaint(Paint paint)
This really refers to the Stroke, TODO: Make separte stroke methods

Parameters:
paint - the paint for this node

getSelectedPaint

Paint getSelectedPaint()
This really refers to the Stroke, TODO: Make separte stroke methods

Returns:
the currently set edge Selectionpaint

getSourceEdgeEndPaint

Paint getSourceEdgeEndPaint()
Returns:
the currently set Source Edge End Type

getSourceEdgeEndSelectedPaint

Paint getSourceEdgeEndSelectedPaint()
Returns:
the currently set Source Edge End Type

getTargetEdgeEndPaint

Paint getTargetEdgeEndPaint()
Returns:
the currently set Target Edge End Type

getTargetEdgeEndSelectedPaint

Paint getTargetEdgeEndSelectedPaint()
Returns:
the currently set Target Edge End Type

setSourceEdgeEndSelectedPaint

void setSourceEdgeEndSelectedPaint(Paint paint)
Parameters:
paint - set the value for the source edge end when selected

setTargetEdgeEndSelectedPaint

void setTargetEdgeEndSelectedPaint(Paint paint)
Parameters:
paint - set the value for the target edge end when selected

setSourceEdgeEndStrokePaint

void setSourceEdgeEndStrokePaint(Paint paint)
Parameters:
paint - the new paint for the stroke of the source eged end

setTargetEdgeEndStrokePaint

void setTargetEdgeEndStrokePaint(Paint paint)
Parameters:
paint - the new paint for the stroke of the target eged end

setSourceEdgeEndPaint

void setSourceEdgeEndPaint(Paint paint)
Parameters:
paint - set the value for the source edge end

setTargetEdgeEndPaint

void setTargetEdgeEndPaint(Paint paint)
Parameters:
paint - set the value for the target edge end

select

void select()

unselect

void unselect()

setSelected

boolean setSelected(boolean state)
When we are selected then we draw ourselves red, and draw any handles.


isSelected

boolean isSelected()
Returns:
selected state

getSelected

boolean getSelected()
Returns:
selected state

isHidden

boolean isHidden()
Returns:
true if the EdgeView is hidden, else false

updateEdgeView

void updateEdgeView()
This is the main method called to update the drawing of the edge.


updateTargetArrow

void updateTargetArrow()
Draws the EdgeEnd, also sets the Source/Target Points to values such that the edge does not "go through" the end


updateSourceArrow

void updateSourceArrow()
Draws the EdgeEnd, also sets the Source/Target Points to values such that the edge does not "go through" the end


setSourceEdgeEnd

void setSourceEdgeEnd(int type)
Sets the Drawing style for the edge end.


setTargetEdgeEnd

void setTargetEdgeEnd(int type)
Sets the Drawing style for the edge end.


getSourceEdgeEnd

int getSourceEdgeEnd()
Return the Drawing style for the edge end.


getTargetEdgeEnd

int getTargetEdgeEnd()
REturn the Drawing style for the edge end.


updateLine

void updateLine()
Draws the Edge


drawSelected

void drawSelected()
Draws the edge as red and draws any handles previously added.


drawUnselected

void drawUnselected()
Draws the edge as black and removes any handles from the display.


getBend

Bend getBend()
Returns:
the Bend used

clearBends

void clearBends()

getLabel

Label getLabel()

setToolTip

void setToolTip(String tip)
Sets what the tooltip will be for this EdgeView


setLabelOffsetX

void setLabelOffsetX(double x)

setLabelOffsetY

void setLabelOffsetY(double y)

setEdgeLabelAnchor

void setEdgeLabelAnchor(int position)

getLabelOffsetX

double getLabelOffsetX()

getLabelOffsetY

double getLabelOffsetY()

getEdgeLabelAnchor

int getEdgeLabelAnchor()

getLabelWidth

double getLabelWidth()

setLabelWidth

void setLabelWidth(double width)

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.