prefuse.visual.tuple

Class TableVisualItem

java.lang.Object

prefuse.data.tuple.TableTuple

prefuse.visual.tuple.TableVisualItem

All Implemented Interfaces:

Tuple, VisualItem

Direct Known Subclasses:

TableAggregateItem, TableDecoratorItem, TableEdgeItem, TableNodeItem

public class TableVisualItem
extends TableTuple
implements VisualItem

VisualItem implementation that uses data values from a backing VisualTable.

Field Summary

Fields inherited from class prefuse.data.tuple.TableTuple

m_row, m_table

Fields inherited from interface prefuse.visual.VisualItem

BOUNDS, DOI, ENDFILLCOLOR, ENDFONT, ENDPOLYGON, ENDSIZE, ENDSTROKECOLOR, ENDTEXTCOLOR, ENDVISIBLE, ENDX, ENDX2, ENDY, ENDY2, EXPANDED, FILLCOLOR, FIXED, FONT, HIGHLIGHT, HOVER, IDX_VALIDATED, INTERACTIVE, LABEL, POLYGON, SCHEMA, SHAPE, SIZE, STARTFILLCOLOR, STARTFONT, STARTPOLYGON, STARTSIZE, STARTSTROKECOLOR, STARTTEXTCOLOR, STARTVISIBLE, STARTX, STARTX2, STARTY, STARTY2, STROKE, STROKECOLOR, TEXTCOLOR, VALIDATED, VALUE, VISIBLE, X, X2, Y, Y2

Constructor Summary

Constructors

Constructor and Description
TableVisualItem()

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.geom.Rectangle2D	getBounds() Get the bounding box for this VisualItem.
double	getDOI() Get the degree-of-interest (DOI) value.
int	getEndFillColor() Get the ending fill color of this item.
java.awt.Font	getEndFont() Get the ending font for the item.
double	getEndSize() Get the ending size value of the item.
int	getEndStrokeColor() Get the ending stroke color of this item.
int	getEndTextColor() Get the ending text color of this item.
double	getEndX() Get the ending x-coordinate of this item.
double	getEndY() Get the ending y-coordinate of this item.
int	getFillColor() Get the current fill color of this item.
java.awt.Font	getFont() Get the current font for the item.
java.lang.String	getGroup() Get the primary data group of which this VisualItem is a member.
Renderer	getRenderer() Get the Renderer instance for drawing this VisualItem.
int	getShape() Get the current shape value of the item.
double	getSize() Get the current size value of the item.
TupleSet	getSourceData() Returns the original backing data set from which this VisualItem is derived.
Tuple	getSourceTuple() Returns the original backing data tuple from which this VisualItem is derived.
int	getStartFillColor() Get the starting fill color of this item.
java.awt.Font	getStartFont() Get the starting font for the item.
double	getStartSize() Get the starting size value of the item.
int	getStartStrokeColor() Get the starting stroke color of this item.
int	getStartTextColor() Get the starting text color of this item.
double	getStartX() Get the starting x-coordinate of this item.
double	getStartY() Get the starting y-coordinate of this item.
java.awt.BasicStroke	getStroke() Get the current stroke used to draw lines and shape outlines.
int	getStrokeColor() Get the current stroke color of this item.
int	getTextColor() Get the current text color of this item.
Visualization	getVisualization() Get the backing Visualization of which this VisualItem is a part.
double	getX() Get the current x-coordinate of this item.
double	getY() Get the current y-coordinate of this item.
protected void	init(Table table, Graph graph, int row) Initialize a new TableVisualItem for the given table and row.
boolean	isEndVisible() Indictes if the end visible flag is set to true.
boolean	isExpanded() Indicates this item is expanded.
boolean	isFixed() Indicates if the item is fixed, and so will not have its position changed by any layout or distortion actions.
boolean	isHighlighted() Indicates if the item is highlighted.
boolean	isHover() Indicates if the item currently has the mouse pointer over it.
boolean	isInGroup(java.lang.String group) Indicates if this item is a member of a given group.
boolean	isInteractive() Indicates if this item is interactive, meaning it can potentially respond to mouse and keyboard input events.
boolean	isStartVisible() Indicates if the start visible flag is set to true.
boolean	isValidated() Indicates if this VisualItem is currently validated.
boolean	isVisible() Indicates if this VisualItem is currently set to be visible.
void	render(java.awt.Graphics2D g) Render this item to the given graphics context.
void	setBounds(double x, double y, double w, double h) Set the bounding box for this item.
void	setDOI(double doi) Set the degree-of-interest (DOI) value.
void	setEndFillColor(int color) Set the ending fill color of this item.
void	setEndFont(java.awt.Font font) Set the ending font for the item.
void	setEndSize(double size) Set the ending size value of the item.
void	setEndStrokeColor(int color) Set the ending stroke color of this item.
void	setEndTextColor(int color) Set the ending text color of this item.
void	setEndVisible(boolean value) Set the end visible flag.
void	setEndX(double x) Set the ending x-coordinate of this item.
void	setEndY(double y) Set the ending y-coordinate of this item.
void	setExpanded(boolean value) Set the expanded flag.
void	setFillColor(int color) Set the current fill color of this item.
void	setFixed(boolean value) Sets if the item is fixed in its position.
void	setFont(java.awt.Font font) Set the current font for the item.
void	setHighlighted(boolean value) Set the highlighted status of this item.
void	setHover(boolean value) Set the hover flag.
void	setInteractive(boolean value) Set the interactive status of this VisualItem.
void	setShape(int shape) Set the current shape value of the item.
void	setSize(double size) Set the current size value of the item.
void	setStartFillColor(int color) Set the starting fill color of this item.
void	setStartFont(java.awt.Font font) Set the starting font for the item.
void	setStartSize(double size) Set the starting size value of the item.
void	setStartStrokeColor(int color) Set the starting stroke color of this item.
void	setStartTextColor(int color) Set the starting text color of this item.
void	setStartVisible(boolean value) Set the start visible flag.
void	setStartX(double x) Set the starting x-coordinate of this item.
void	setStartY(double y) Set the starting y-coordinate of this item.
void	setStroke(java.awt.BasicStroke stroke) Set the current stroke used to draw lines and shape outlines.
void	setStrokeColor(int color) Set the current stroke color of this item.
void	setTextColor(int color) Set the current text color of this item.
void	setValidated(boolean value) Set this item's validated flag.
void	setVisible(boolean value) Set this item's visibility.
void	setX(double x) Set the current x-coordinate of this item.
void	setY(double y) Set the current y-coordinate of this item.
java.lang.String	toString()
java.awt.geom.Rectangle2D	validateBounds() Validate the bounds of this VisualItem.

Methods inherited from class prefuse.data.tuple.TableTuple

canGet, canGetBoolean, canGetDate, canGetDouble, canGetFloat, canGetInt, canGetLong, canGetString, canSet, canSetBoolean, canSetDate, canSetDouble, canSetFloat, canSetInt, canSetLong, canSetString, get, get, getBoolean, getBoolean, getColumnCount, getColumnIndex, getColumnName, getColumnType, getColumnType, getDate, getDate, getDefault, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRow, getSchema, getString, getString, getTable, isValid, revertToDefault, set, set, setBoolean, setBoolean, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setString, setString

Methods inherited from class java.lang.Object

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

Methods inherited from interface prefuse.data.Tuple

canGet, canGetBoolean, canGetDate, canGetDouble, canGetFloat, canGetInt, canGetLong, canGetString, canSet, canSetBoolean, canSetDate, canSetDouble, canSetFloat, canSetInt, canSetLong, canSetString, get, get, getBoolean, getBoolean, getColumnCount, getColumnIndex, getColumnName, getColumnType, getColumnType, getDate, getDate, getDefault, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getRow, getSchema, getString, getString, getTable, isValid, revertToDefault, set, set, setBoolean, setBoolean, setDate, setDate, setDouble, setDouble, setFloat, setFloat, setInt, setInt, setLong, setLong, setString, setString

Constructor Detail

TableVisualItem

public TableVisualItem()

Method Detail

init

protected void init(Table table,
        Graph graph,
        int row)

Initialize a new TableVisualItem for the given table and row. This method is used by the appropriate TupleManager instance, and should not be called directly by client code, unless by a client-supplied custom TupleManager.

Overrides:

init in class TableTuple

Parameters:

table - the data Table

graph - ignored by this class

row - the table row index

getVisualization

public Visualization getVisualization()

Description copied from interface: VisualItem

Get the backing Visualization of which this VisualItem is a part.

Specified by:

getVisualization in interface VisualItem

Returns:

the backing Visualization

See Also:

VisualItem.getVisualization()

getGroup

public java.lang.String getGroup()

Description copied from interface: VisualItem

Get the primary data group of which this VisualItem is a member. Returns the name of the group of this item's backing VisualTable.

Specified by:

getGroup in interface VisualItem

Returns:

the item's primary group

See Also:

VisualItem.getGroup()

isInGroup

public boolean isInGroup(java.lang.String group)

Description copied from interface: VisualItem

Indicates if this item is a member of a given group. This includes both the item's primary group (that of it's backing VisualTable) and any number of additional focus groups associated with the Visualization.

Specified by:

isInGroup in interface VisualItem

Parameters:

group - the group to check for membership.

Returns:

true if this item is in the group, false otherwise.

See Also:

VisualItem.isInGroup(java.lang.String)

getSourceData

public TupleSet getSourceData()

Description copied from interface: VisualItem

Returns the original backing data set from which this VisualItem is derived. This could be a Table, Graph, or Tree instance. This method returns null if this VisualItem is not derived from backing data.

Specified by:

getSourceData in interface VisualItem

Returns:

the backing data set from which this VisualItem is derived, or null if none.

See Also:

VisualItem.getSourceData()

getSourceTuple

public Tuple getSourceTuple()

Description copied from interface: VisualItem

Returns the original backing data tuple from which this VisualItem is derived. This could be a Tuple, Node, or Edge instance. This method returns null if this VisualItem is not derived from backing data.

Specified by:

getSourceTuple in interface VisualItem

Returns:

the backing data tuple from which this VisualItem is derived, or null if none.

See Also:

VisualItem.getSourceTuple()

toString

public java.lang.String toString()

Overrides:

toString in class TableTuple

See Also:

Object.toString()

render

public void render(java.awt.Graphics2D g)

Description copied from interface: VisualItem

Render this item to the given graphics context. This is typically done by requesting the appropriate Renderer from the backing Visualization's RendererFactory, and then using the Renderer to draw this item.

Specified by:

render in interface VisualItem

Parameters:

g - the graphics context to render into.

See Also:

VisualItem.render(java.awt.Graphics2D)

getRenderer

public Renderer getRenderer()

Description copied from interface: VisualItem

Get the Renderer instance for drawing this VisualItem. The Renderer is retrieved by requesting it from the backing Visualization's RendererFactory.

Specified by:

getRenderer in interface VisualItem

Returns:

the Renderer for this VisualItem

See Also:

VisualItem.getRenderer()

validateBounds

public java.awt.geom.Rectangle2D validateBounds()

Description copied from interface: VisualItem

Validate the bounds of this VisualItem. When a data value for a VisualItem is updated, it's bounds are invalidated, as the data change may have changed to appearance of the item. Revalidating the bounds causes the bounds of the item to be recomputed and made current.

Specified by:

validateBounds in interface VisualItem

Returns:

the validated boundig box of this item

See Also:

VisualItem.validateBounds()

isValidated

public boolean isValidated()

Description copied from interface: VisualItem

Indicates if this VisualItem is currently validated. If not, validateBounds() must be run to update the bounds to a current value.

Specified by:

isValidated in interface VisualItem

Returns:

true if validated, false otherwise

See Also:

VisualItem.isValidated()

setValidated

public void setValidated(boolean value)

Description copied from interface: VisualItem

Set this item's validated flag. This is for internal use by prefuse and, in general, should not be called by application code.

Specified by:

setValidated in interface VisualItem

Parameters:

value - the value of the validated flag to set.

See Also:

VisualItem.setValidated(boolean)

isVisible

public boolean isVisible()

Description copied from interface: VisualItem

Indicates if this VisualItem is currently set to be visible. Items with the visible flag set false will not be drawn by a display. Invisible items are also by necessity not interactive, regardless of the value of the interactive flag.

Specified by:

isVisible in interface VisualItem

Returns:

true if visible, false if invisible

See Also:

VisualItem.isVisible()

setVisible

public void setVisible(boolean value)

Description copied from interface: VisualItem

Set this item's visibility.

Specified by:

setVisible in interface VisualItem

Parameters:

value - true to make the item visible, false otherwise.

See Also:

VisualItem.setVisible(boolean)

isStartVisible

public boolean isStartVisible()

Description copied from interface: VisualItem

Indicates if the start visible flag is set to true. This is the visibility value consulted for the staring value of the visibility field at the beginning of an animated transition.

Specified by:

isStartVisible in interface VisualItem

Returns:

true if this item starts out visible, false otherwise.

See Also:

VisualItem.isStartVisible()

setStartVisible

public void setStartVisible(boolean value)

Description copied from interface: VisualItem

Set the start visible flag.

Specified by:

setStartVisible in interface VisualItem

Parameters:

value - true to set the start visible flag, false otherwise

See Also:

VisualItem.setStartVisible(boolean)

isEndVisible

public boolean isEndVisible()

Description copied from interface: VisualItem

Indictes if the end visible flag is set to true. This is the visibility value consulted for the ending value of the visibility field at the end of an animated transition.

Specified by:

isEndVisible in interface VisualItem

Returns:

true if this items ends visible, false otherwise.

See Also:

VisualItem.isEndVisible()

setEndVisible

public void setEndVisible(boolean value)

Description copied from interface: VisualItem

Set the end visible flag.

Specified by:

setEndVisible in interface VisualItem

Parameters:

value - true to set the end visible flag, false otherwise

See Also:

VisualItem.setEndVisible(boolean)

isInteractive

public boolean isInteractive()

Description copied from interface: VisualItem

Indicates if this item is interactive, meaning it can potentially respond to mouse and keyboard input events.

Specified by:

isInteractive in interface VisualItem

Returns:

true if the item is interactive, false otherwise

See Also:

VisualItem.isInteractive()

setInteractive

public void setInteractive(boolean value)

Description copied from interface: VisualItem

Set the interactive status of this VisualItem.

Specified by:

setInteractive in interface VisualItem

Parameters:

value - true for interactive, false for non-interactive

See Also:

VisualItem.setInteractive(boolean)

isExpanded

public boolean isExpanded()

Description copied from interface: VisualItem

Indicates this item is expanded. Only used for items that are part of a graph structure.

Specified by:

isExpanded in interface VisualItem

Returns:

true if expanded, false otherwise

See Also:

VisualItem.isExpanded()

setExpanded

public void setExpanded(boolean value)

Description copied from interface: VisualItem

Set the expanded flag.

Specified by:

setExpanded in interface VisualItem

Parameters:

value - true to set as expanded, false as collapsed.

See Also:

VisualItem.setExpanded(boolean)

isFixed

public boolean isFixed()

Description copied from interface: VisualItem

Indicates if the item is fixed, and so will not have its position changed by any layout or distortion actions.

Specified by:

isFixed in interface VisualItem

Returns:

true if the item has a fixed position, false otherwise

See Also:

VisualItem.isFixed()

setFixed

public void setFixed(boolean value)

Description copied from interface: VisualItem

Sets if the item is fixed in its position.

Specified by:

setFixed in interface VisualItem

Parameters:

value - true to fix the item, false otherwise

See Also:

VisualItem.setFixed(boolean)

isHighlighted

public boolean isHighlighted()

Description copied from interface: VisualItem

Indicates if the item is highlighted.

Specified by:

isHighlighted in interface VisualItem

Returns:

true for highlighted, false for not highlighted

See Also:

VisualItem.isHighlighted()

setHighlighted

public void setHighlighted(boolean value)

Description copied from interface: VisualItem

Set the highlighted status of this item. How higlighting values are interpreted by the system depends on the various processing actions set up for an application (e.g., how a ColorAction might assign colors based on the flag).

Specified by:

setHighlighted in interface VisualItem

Parameters:

value - true to highlight the item, false for no highlighting.

See Also:

VisualItem.setHighlighted(boolean)

isHover

public boolean isHover()

Description copied from interface: VisualItem

Indicates if the item currently has the mouse pointer over it.

Specified by:

isHover in interface VisualItem

Returns:

true if the mouse pointer is over this item, false otherwise

See Also:

VisualItem.isHover()

setHover

public void setHover(boolean value)

Description copied from interface: VisualItem

Set the hover flag. This is set automatically by the prefuse framework, so should not need to be set explicitly by application code.

Specified by:

setHover in interface VisualItem

Parameters:

value - true to set the hover flag, false otherwise

See Also:

VisualItem.setHover(boolean)

getX

public double getX()

Description copied from interface: VisualItem

Get the current x-coordinate of this item.

Specified by:

getX in interface VisualItem

Returns:

the current x-coordinate

See Also:

VisualItem.getX()

setX

public void setX(double x)

Description copied from interface: VisualItem

Set the current x-coordinate of this item.

Specified by:

setX in interface VisualItem

Parameters:

x - the new current x-coordinate

See Also:

VisualItem.setX(double)

getY

public double getY()

Description copied from interface: VisualItem

Get the current y-coordinate of this item.

Specified by:

getY in interface VisualItem

Returns:

the current y-coordinate

See Also:

VisualItem.getY()

setY

public void setY(double y)

Description copied from interface: VisualItem

Set the current y-coordinate of this item.

Specified by:

setY in interface VisualItem

Parameters:

y - the new current y-coordinate

See Also:

VisualItem.setY(double)

getStartX

public double getStartX()

Description copied from interface: VisualItem

Get the starting x-coordinate of this item.

Specified by:

getStartX in interface VisualItem

Returns:

the starting x-coordinate

See Also:

VisualItem.getStartX()

setStartX

public void setStartX(double x)

Description copied from interface: VisualItem

Set the starting x-coordinate of this item.

Specified by:

setStartX in interface VisualItem

Parameters:

x - the new starting x-coordinate

See Also:

VisualItem.setStartX(double)

getStartY

public double getStartY()

Description copied from interface: VisualItem

Get the starting y-coordinate of this item.

Specified by:

getStartY in interface VisualItem

Returns:

the starting y-coordinate

See Also:

VisualItem.getStartY()

setStartY

public void setStartY(double y)

Description copied from interface: VisualItem

Set the starting y-coordinate of this item.

Specified by:

setStartY in interface VisualItem

Parameters:

y - the new starting y-coordinate

See Also:

VisualItem.setStartY(double)

getEndX

public double getEndX()

Description copied from interface: VisualItem

Get the ending x-coordinate of this item.

Specified by:

getEndX in interface VisualItem

Returns:

the ending x-coordinate

See Also:

VisualItem.getEndX()

setEndX

public void setEndX(double x)

Description copied from interface: VisualItem

Set the ending x-coordinate of this item.

Specified by:

setEndX in interface VisualItem

Parameters:

x - the new ending x-coordinate

See Also:

VisualItem.setEndX(double)

getEndY

public double getEndY()

Description copied from interface: VisualItem

Get the ending y-coordinate of this item.

Specified by:

getEndY in interface VisualItem

Returns:

the ending y-coordinate

See Also:

VisualItem.getEndY()

setEndY

public void setEndY(double y)

Description copied from interface: VisualItem

Set the ending y-coordinate of this item.

Specified by:

setEndY in interface VisualItem

Parameters:

y - the new ending y-coordinate

See Also:

VisualItem.setEndY(double)

getBounds

public java.awt.geom.Rectangle2D getBounds()

Description copied from interface: VisualItem

Get the bounding box for this VisualItem. If necessary, the bounds will be validated before returning the bounding box.

Specified by:

getBounds in interface VisualItem

Returns:

the item's bounding box

See Also:

VisualItem.getBounds()

setBounds

public void setBounds(double x,
             double y,
             double w,
             double h)

Description copied from interface: VisualItem

Set the bounding box for this item. This method is used by Renderer modules when the bounds are validated, or set by processing Actions used in conjunction with Renderers that do not perform bounds management.

Specified by:

setBounds in interface VisualItem

Parameters:

x - the minimum x-coordinate

y - the minimum y-coorindate

w - the width of this item

h - the height of this item

See Also:

VisualItem.setBounds(double, double, double, double)

getStrokeColor

public int getStrokeColor()

Description copied from interface: VisualItem

Get the current stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

getStrokeColor in interface VisualItem

Returns:

the current stroke color, represented as an integer

See Also:

VisualItem.getStrokeColor()

setStrokeColor

public void setStrokeColor(int color)

Description copied from interface: VisualItem

Set the current stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setStrokeColor in interface VisualItem

Parameters:

color - the current stroke color, represented as an integer

See Also:

VisualItem.setStrokeColor(int)

getStartStrokeColor

public int getStartStrokeColor()

Description copied from interface: VisualItem

Get the starting stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

getStartStrokeColor in interface VisualItem

Returns:

the starting stroke color, represented as an integer

See Also:

VisualItem.getStartStrokeColor()

setStartStrokeColor

public void setStartStrokeColor(int color)

Description copied from interface: VisualItem

Set the starting stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setStartStrokeColor in interface VisualItem

Parameters:

color - the starting stroke color, represented as an integer

See Also:

VisualItem.setStartStrokeColor(int)

getEndStrokeColor

public int getEndStrokeColor()

Description copied from interface: VisualItem

Get the ending stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

getEndStrokeColor in interface VisualItem

Returns:

the ending stroke color, represented as an integer

See Also:

VisualItem.getEndStrokeColor()

setEndStrokeColor

public void setEndStrokeColor(int color)

Description copied from interface: VisualItem

Set the ending stroke color of this item. The stroke color is used to draw lines and the outlines of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setEndStrokeColor in interface VisualItem

Parameters:

color - the ending stroke color, represented as an integer

See Also:

VisualItem.setEndStrokeColor(int)

getFillColor

public int getFillColor()

Description copied from interface: VisualItem

Get the current fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

getFillColor in interface VisualItem

Returns:

the current fill color, represented as an integer

See Also:

VisualItem.getFillColor()

setFillColor

public void setFillColor(int color)

Description copied from interface: VisualItem

Set the current fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setFillColor in interface VisualItem

Parameters:

color - the current fill color, represented as an integer

See Also:

VisualItem.setFillColor(int)

getStartFillColor

public int getStartFillColor()

Description copied from interface: VisualItem

Get the starting fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with zero alpha component is fully transparent and will not be drawn.

Specified by:

getStartFillColor in interface VisualItem

Returns:

the starting fill color, represented as an integer

See Also:

VisualItem.getStartFillColor()

setStartFillColor

public void setStartFillColor(int color)

Description copied from interface: VisualItem

Set the starting fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setStartFillColor in interface VisualItem

Parameters:

color - the starting fill color, represented as an integer

See Also:

VisualItem.setStartFillColor(int)

getEndFillColor

public int getEndFillColor()

Description copied from interface: VisualItem

Get the ending fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with zero alpha component is fully transparent and will not be drawn.

Specified by:

getEndFillColor in interface VisualItem

Returns:

the ending fill color, represented as an integer

See Also:

VisualItem.getEndFillColor()

setEndFillColor

public void setEndFillColor(int color)

Description copied from interface: VisualItem

Set the ending fill color of this item. The fill color is used to fill the interior of shapes. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setEndFillColor in interface VisualItem

Parameters:

color - the ending fill color, represented as an integer

See Also:

VisualItem.setEndFillColor(int)

getTextColor

public int getTextColor()

Description copied from interface: VisualItem

Get the current text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with zero alpha component is fully transparent and will not be drawn.

Specified by:

getTextColor in interface VisualItem

Returns:

the current text color, represented as an integer

See Also:

VisualItem.getTextColor()

setTextColor

public void setTextColor(int color)

Description copied from interface: VisualItem

Set the current text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setTextColor in interface VisualItem

Parameters:

color - the current text color, represented as an integer

See Also:

VisualItem.setTextColor(int)

getStartTextColor

public int getStartTextColor()

Description copied from interface: VisualItem

Get the starting text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with zero alpha component is fully transparent and will not be drawn.

Specified by:

getStartTextColor in interface VisualItem

Returns:

the starting text color, represented as an integer

See Also:

VisualItem.getStartTextColor()

setStartTextColor

public void setStartTextColor(int color)

Description copied from interface: VisualItem

Set the starting text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setStartTextColor in interface VisualItem

Parameters:

color - the starting text color, represented as an integer

See Also:

VisualItem.setStartTextColor(int)

getEndTextColor

public int getEndTextColor()

Description copied from interface: VisualItem

Get the ending text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with zero alpha component is fully transparent and will not be drawn.

Specified by:

getEndTextColor in interface VisualItem

Returns:

the ending text color, represented as an integer

See Also:

VisualItem.getEndTextColor()

setEndTextColor

public void setEndTextColor(int color)

Description copied from interface: VisualItem

Set the ending text color of this item. The text color is used to draw text strings for the item. Color values as represented as an integer containing the red, green, blue, and alpha (transparency) color channels. A color with a zero alpha component is fully transparent and will not be drawn.

Specified by:

setEndTextColor in interface VisualItem

Parameters:

color - the ending text color, represented as an integer

See Also:

VisualItem.setEndTextColor(int)

getSize

public double getSize()

Description copied from interface: VisualItem

Get the current size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

getSize in interface VisualItem

Returns:

the current size value

See Also:

VisualItem.getSize()

setSize

public void setSize(double size)

Description copied from interface: VisualItem

Set the current size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

setSize in interface VisualItem

Parameters:

size - the current size value

See Also:

VisualItem.setSize(double)

getStartSize

public double getStartSize()

Description copied from interface: VisualItem

Get the starting size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

getStartSize in interface VisualItem

Returns:

the starting size value

See Also:

VisualItem.getStartSize()

setStartSize

public void setStartSize(double size)

Description copied from interface: VisualItem

Set the starting size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

setStartSize in interface VisualItem

Parameters:

size - the starting size value

See Also:

VisualItem.setStartSize(double)

getEndSize

public double getEndSize()

Description copied from interface: VisualItem

Get the ending size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

getEndSize in interface VisualItem

Returns:

the ending size value

See Also:

VisualItem.getEndSize()

setEndSize

public void setEndSize(double size)

Description copied from interface: VisualItem

Set the ending size value of the item. Size values are typically used to scale an item, either in one-dimension (e.g., a bar chart length) or two-dimensions (e.g., using pixel area to encode a quantitative value).

Specified by:

setEndSize in interface VisualItem

Parameters:

size - the ending size value

See Also:

VisualItem.setEndSize(double)

getShape

public int getShape()

Description copied from interface: VisualItem

Get the current shape value of the item. One of the SHAPE constants included in the Constants class. This value only has an effect if a Renderer that supports different shapes is used (e.g., ShapeRenderer.

Specified by:

getShape in interface VisualItem

Returns:

the current shape value

See Also:

VisualItem.getShape()

setShape

public void setShape(int shape)

Description copied from interface: VisualItem

Set the current shape value of the item. One of the SHAPE constants included in the Constants class. This value only has an effect if a Renderer that supports different shapes is used (e.g., ShapeRenderer.

Specified by:

setShape in interface VisualItem

Parameters:

shape - the shape value to use

See Also:

VisualItem.setShape(int)

getStroke

public java.awt.BasicStroke getStroke()

Description copied from interface: VisualItem

Get the current stroke used to draw lines and shape outlines.

Specified by:

getStroke in interface VisualItem

Returns:

the stroke used to draw lines and shape outlines

See Also:

VisualItem.getStroke()

setStroke

public void setStroke(java.awt.BasicStroke stroke)

Description copied from interface: VisualItem

Set the current stroke used to draw lines and shape outlines.

Specified by:

setStroke in interface VisualItem

Parameters:

stroke - the stroke to use to draw lines and shape outlines

See Also:

VisualItem.setStroke(java.awt.BasicStroke)

getFont

public java.awt.Font getFont()

Description copied from interface: VisualItem

Get the current font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

getFont in interface VisualItem

Returns:

the current font value

See Also:

VisualItem.getFont()

setFont

public void setFont(java.awt.Font font)

Description copied from interface: VisualItem

Set the current font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

setFont in interface VisualItem

Parameters:

font - the current font value

See Also:

VisualItem.setFont(java.awt.Font)

getStartFont

public java.awt.Font getStartFont()

Description copied from interface: VisualItem

Get the starting font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

getStartFont in interface VisualItem

Returns:

the starting font value

See Also:

VisualItem.getStartFont()

setStartFont

public void setStartFont(java.awt.Font font)

Description copied from interface: VisualItem

Set the starting font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

setStartFont in interface VisualItem

Parameters:

font - the starting font value

See Also:

VisualItem.setStartFont(java.awt.Font)

getEndFont

public java.awt.Font getEndFont()

Description copied from interface: VisualItem

Get the ending font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

getEndFont in interface VisualItem

Returns:

the ending font value

See Also:

VisualItem.getEndFont()

setEndFont

public void setEndFont(java.awt.Font font)

Description copied from interface: VisualItem

Set the ending font for the item. The font is used as the default typeface for drawing text for this item.

Specified by:

setEndFont in interface VisualItem

Parameters:

font - the ending font value

See Also:

VisualItem.setEndFont(java.awt.Font)

getDOI

public double getDOI()

Description copied from interface: VisualItem

Get the degree-of-interest (DOI) value. The degree-of-interet is an optional value that can be used to sort items by importance, control item visibility, or influence particular visual encodings. A common example is to use the DOI to store the graph distance of a node from the nearest selected focus node.

Specified by:

getDOI in interface VisualItem

Returns:

the DOI value of this item

See Also:

VisualItem.getDOI()

setDOI

public void setDOI(double doi)

Description copied from interface: VisualItem

Set the degree-of-interest (DOI) value. The degree-of-interet is an optional value that can be used to sort items by importance, control item visibility, or influence particular visual encodings. A common example is to use the DOI to store the graph distance of a node from the nearest selected focus node.

Specified by:

setDOI in interface VisualItem

Parameters:

doi - the DOI value of this item

See Also:

VisualItem.setDOI(double)