prefuse.visual
Interface VisualItem

All Superinterfaces:
Tuple
All Known Subinterfaces:
AggregateItem, DecoratorItem, EdgeItem, NodeItem
All Known Implementing Classes:
TableAggregateItem, TableDecoratorItem, TableEdgeItem, TableNodeItem, TableVisualItem

public interface VisualItem
extends Tuple

Base interface for representing a visual item, a data object with a visual interactive form. VisualItems are Tuple instances, and so can support any number of data fields in a backing data table. VisualItems also support data fields specific to visualization, such as a location, bounding box, colors, size, and font. The VisualItem interface provides convenience methods for accessing these common visual properties, but the underlying mechanism is the same as any Tuple -- data stored in a tabular format. Just as all Tuple instances are backed by a data Table, each VisualItem is backed by a VisualTable. Additionally, each VisualItem is associated with one and only one Visualization.

VisualItems are only responsible for storing their visual data properties. The final visual appearance of an item is determined by a Renderer, which contains instructions for drawing the item. The Renderer to use for a given item is decided by the RendererFactory associated with the item's backing Visualization.

Finally, actually setting the visual properties of VisualItems is commonly done by the many Action modules available for processing visual data. This includes spatial layout as well as color, size, and font assignment.

Author:
jeffrey heer

Field Summary
static java.lang.String BOUNDS
          The bounds data field
static java.lang.String DOI
          The doi data field
static java.lang.String ENDFILLCOLOR
          The end fill color data field
static java.lang.String ENDFONT
          The end font data field
static java.lang.String ENDPOLYGON
          The end polygon data field.
static java.lang.String ENDSIZE
          The end size data field
static java.lang.String ENDSTROKECOLOR
          The end stroke color data field
static java.lang.String ENDTEXTCOLOR
          The end text color data field
static java.lang.String ENDVISIBLE
          The end visible data field
static java.lang.String ENDX
          The end x data field
static java.lang.String ENDX2
          The end x2 data field.
static java.lang.String ENDY
          The end y data field
static java.lang.String ENDY2
          The end y2 data field.
static java.lang.String EXPANDED
          The expanded data field
static java.lang.String FILLCOLOR
          The fill color data field
static java.lang.String FIXED
          The fixed data field
static java.lang.String FONT
          The font data field
static java.lang.String HIGHLIGHT
          The highlight data field
static java.lang.String HOVER
          The hover data field
static int IDX_VALIDATED
          The column index of the validated data field.
static java.lang.String INTERACTIVE
          The interactive data field
static java.lang.String LABEL
          The label data field.
static java.lang.String POLYGON
          The polygon data field.
static Schema SCHEMA
          A permanent, locked copy of the base VisualItem schema
static java.lang.String SHAPE
          The shape data field
static java.lang.String SIZE
          The size data field
static java.lang.String STARTFILLCOLOR
          The start fill color data field
static java.lang.String STARTFONT
          The start font data field
static java.lang.String STARTPOLYGON
          The start polygon data field.
static java.lang.String STARTSIZE
          The start size data field
static java.lang.String STARTSTROKECOLOR
          The start stroke color data field
static java.lang.String STARTTEXTCOLOR
          The start text color data field
static java.lang.String STARTVISIBLE
          The start visible data field
static java.lang.String STARTX
          The start x data field
static java.lang.String STARTX2
          The start x2 data field.
static java.lang.String STARTY
          The start y data field
static java.lang.String STARTY2
          The start y2 data field.
static java.lang.String STROKE
          The stroke data field
static java.lang.String STROKECOLOR
          The stroke color data field
static java.lang.String TEXTCOLOR
          The text color data field
static java.lang.String VALIDATED
          The validated data field
static java.lang.String VALUE
          The value data field.
static java.lang.String VISIBLE
          The visible data field
static java.lang.String X
          The x data field
static java.lang.String X2
          The x2 data field.
static java.lang.String Y
          The y data field
static java.lang.String Y2
          The y2 data field.
 
Method Summary
 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.
 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.awt.geom.Rectangle2D validateBounds()
          Validate the bounds of this VisualItem.
 
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
 

Field Detail

VALIDATED

static final java.lang.String VALIDATED
The validated data field


VISIBLE

static final java.lang.String VISIBLE
The visible data field


STARTVISIBLE

static final java.lang.String STARTVISIBLE
The start visible data field


ENDVISIBLE

static final java.lang.String ENDVISIBLE
The end visible data field


INTERACTIVE

static final java.lang.String INTERACTIVE
The interactive data field


EXPANDED

static final java.lang.String EXPANDED
The expanded data field


FIXED

static final java.lang.String FIXED
The fixed data field


HIGHLIGHT

static final java.lang.String HIGHLIGHT
The highlight data field


HOVER

static final java.lang.String HOVER
The hover data field


X

static final java.lang.String X
The x data field


Y

static final java.lang.String Y
The y data field


STARTX

static final java.lang.String STARTX
The start x data field


STARTY

static final java.lang.String STARTY
The start y data field


ENDX

static final java.lang.String ENDX
The end x data field


ENDY

static final java.lang.String ENDY
The end y data field


BOUNDS

static final java.lang.String BOUNDS
The bounds data field


STROKECOLOR

static final java.lang.String STROKECOLOR
The stroke color data field


STARTSTROKECOLOR

static final java.lang.String STARTSTROKECOLOR
The start stroke color data field


ENDSTROKECOLOR

static final java.lang.String ENDSTROKECOLOR
The end stroke color data field


FILLCOLOR

static final java.lang.String FILLCOLOR
The fill color data field


STARTFILLCOLOR

static final java.lang.String STARTFILLCOLOR
The start fill color data field


ENDFILLCOLOR

static final java.lang.String ENDFILLCOLOR
The end fill color data field


TEXTCOLOR

static final java.lang.String TEXTCOLOR
The text color data field


STARTTEXTCOLOR

static final java.lang.String STARTTEXTCOLOR
The start text color data field


ENDTEXTCOLOR

static final java.lang.String ENDTEXTCOLOR
The end text color data field


SIZE

static final java.lang.String SIZE
The size data field


STARTSIZE

static final java.lang.String STARTSIZE
The start size data field


ENDSIZE

static final java.lang.String ENDSIZE
The end size data field


SHAPE

static final java.lang.String SHAPE
The shape data field


STROKE

static final java.lang.String STROKE
The stroke data field


FONT

static final java.lang.String FONT
The font data field


STARTFONT

static final java.lang.String STARTFONT
The start font data field


ENDFONT

static final java.lang.String ENDFONT
The end font data field


DOI

static final java.lang.String DOI
The doi data field


SCHEMA

static final Schema SCHEMA
A permanent, locked copy of the base VisualItem schema


IDX_VALIDATED

static final int IDX_VALIDATED
The column index of the validated data field. This should be safe to do because a unique (non-inherited) validated field is required of all VisualItems, and should always be the first field included.


LABEL

static final java.lang.String LABEL
The label data field. Not included in the VisualItem schema by default


VALUE

static final java.lang.String VALUE
The value data field. Not included in the VisualItem schema by default


POLYGON

static final java.lang.String POLYGON
The polygon data field. Not included in the VisualItem schema by default


STARTPOLYGON

static final java.lang.String STARTPOLYGON
The start polygon data field. Not included in the VisualItem schema by default


ENDPOLYGON

static final java.lang.String ENDPOLYGON
The end polygon data field. Not included in the VisualItem schema by default


X2

static final java.lang.String X2
The x2 data field. Not included in the VisualItem schema by default


Y2

static final java.lang.String Y2
The y2 data field. Not included in the VisualItem schema by default


STARTX2

static final java.lang.String STARTX2
The start x2 data field. Not included in the VisualItem schema by default


STARTY2

static final java.lang.String STARTY2
The start y2 data field. Not included in the VisualItem schema by default


ENDX2

static final java.lang.String ENDX2
The end x2 data field. Not included in the VisualItem schema by default


ENDY2

static final java.lang.String ENDY2
The end y2 data field. Not included in the VisualItem schema by default

Method Detail

getVisualization

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

Returns:
the backing Visualization

getGroup

java.lang.String getGroup()
Get the primary data group of which this VisualItem is a member. Returns the name of the group of this item's backing VisualTable.

Returns:
the item's primary group

isInGroup

boolean isInGroup(java.lang.String group)
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.

Parameters:
group - the group to check for membership.
Returns:
true if this item is in the group, false otherwise.

getSourceData

TupleSet getSourceData()
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.

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

getSourceTuple

Tuple getSourceTuple()
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.

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

render

void render(java.awt.Graphics2D g)
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.

Parameters:
g - the graphics context to render into.

getRenderer

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

Returns:
the Renderer for this VisualItem

validateBounds

java.awt.geom.Rectangle2D validateBounds()
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.

Returns:
the validated boundig box of this item

isValidated

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

Returns:
true if validated, false otherwise
See Also:
VALIDATED

setValidated

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

Parameters:
value - the value of the validated flag to set.
See Also:
VALIDATED

isVisible

boolean isVisible()
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.

Returns:
true if visible, false if invisible
See Also:
VISIBLE

setVisible

void setVisible(boolean value)
Set this item's visibility.

Parameters:
value - true to make the item visible, false otherwise.
See Also:
VISIBLE

isStartVisible

boolean isStartVisible()
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.

Returns:
true if this item starts out visible, false otherwise.
See Also:
STARTVISIBLE

setStartVisible

void setStartVisible(boolean value)
Set the start visible flag.

Parameters:
value - true to set the start visible flag, false otherwise
See Also:
STARTVISIBLE

isEndVisible

boolean isEndVisible()
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.

Returns:
true if this items ends visible, false otherwise.
See Also:
ENDVISIBLE

setEndVisible

void setEndVisible(boolean value)
Set the end visible flag.

Parameters:
value - true to set the end visible flag, false otherwise
See Also:
ENDVISIBLE

isInteractive

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

Returns:
true if the item is interactive, false otherwise
See Also:
INTERACTIVE

setInteractive

void setInteractive(boolean value)
Set the interactive status of this VisualItem.

Parameters:
value - true for interactive, false for non-interactive
See Also:
INTERACTIVE

isExpanded

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

Returns:
true if expanded, false otherwise
See Also:
EXPANDED

setExpanded

void setExpanded(boolean value)
Set the expanded flag.

Parameters:
value - true to set as expanded, false as collapsed.
See Also:
EXPANDED

isFixed

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

Returns:
true if the item has a fixed position, false otherwise
See Also:
FIXED

setFixed

void setFixed(boolean value)
Sets if the item is fixed in its position.

Parameters:
value - true to fix the item, false otherwise
See Also:
FIXED

isHighlighted

boolean isHighlighted()
Indicates if the item is highlighted.

Returns:
true for highlighted, false for not highlighted
See Also:
HIGHLIGHT

setHighlighted

void setHighlighted(boolean value)
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).

Parameters:
value - true to highlight the item, false for no highlighting.
See Also:
HIGHLIGHT

isHover

boolean isHover()
Indicates if the item currently has the mouse pointer over it.

Returns:
true if the mouse pointer is over this item, false otherwise
See Also:
HOVER

setHover

void setHover(boolean value)
Set the hover flag. This is set automatically by the prefuse framework, so should not need to be set explicitly by application code.

Parameters:
value - true to set the hover flag, false otherwise
See Also:
HOVER

getX

double getX()
Get the current x-coordinate of this item.

Returns:
the current x-coordinate
See Also:
X

setX

void setX(double x)
Set the current x-coordinate of this item.

Parameters:
x - the new current x-coordinate
See Also:
X

getY

double getY()
Get the current y-coordinate of this item.

Returns:
the current y-coordinate
See Also:
Y

setY

void setY(double y)
Set the current y-coordinate of this item.

Parameters:
y - the new current y-coordinate
See Also:
Y

getStartX

double getStartX()
Get the starting x-coordinate of this item.

Returns:
the starting x-coordinate
See Also:
STARTX

setStartX

void setStartX(double x)
Set the starting x-coordinate of this item.

Parameters:
x - the new starting x-coordinate
See Also:
STARTX

getStartY

double getStartY()
Get the starting y-coordinate of this item.

Returns:
the starting y-coordinate
See Also:
STARTY

setStartY

void setStartY(double y)
Set the starting y-coordinate of this item.

Parameters:
y - the new starting y-coordinate
See Also:
STARTY

getEndX

double getEndX()
Get the ending x-coordinate of this item.

Returns:
the ending x-coordinate
See Also:
ENDX

setEndX

void setEndX(double x)
Set the ending x-coordinate of this item.

Parameters:
x - the new ending x-coordinate
See Also:
ENDX

getEndY

double getEndY()
Get the ending y-coordinate of this item.

Returns:
the ending y-coordinate
See Also:
ENDY

setEndY

void setEndY(double y)
Set the ending y-coordinate of this item.

Parameters:
y - the new ending y-coordinate
See Also:
ENDY

getBounds

java.awt.geom.Rectangle2D getBounds()
Get the bounding box for this VisualItem. If necessary, the bounds will be validated before returning the bounding box.

Returns:
the item's bounding box
See Also:
BOUNDS

setBounds

void setBounds(double x,
               double y,
               double w,
               double h)
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.

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:
BOUNDS

getStrokeColor

int getStrokeColor()
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.

Returns:
the current stroke color, represented as an integer
See Also:
ColorLib, STROKECOLOR

setStrokeColor

void setStrokeColor(int color)
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.

Parameters:
color - the current stroke color, represented as an integer
See Also:
ColorLib, STROKECOLOR

getStartStrokeColor

int getStartStrokeColor()
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.

Returns:
the starting stroke color, represented as an integer
See Also:
ColorLib, STARTSTROKECOLOR

setStartStrokeColor

void setStartStrokeColor(int color)
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.

Parameters:
color - the starting stroke color, represented as an integer
See Also:
ColorLib, STARTSTROKECOLOR

getEndStrokeColor

int getEndStrokeColor()
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.

Returns:
the ending stroke color, represented as an integer
See Also:
ColorLib, ENDSTROKECOLOR

setEndStrokeColor

void setEndStrokeColor(int color)
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.

Parameters:
color - the ending stroke color, represented as an integer
See Also:
ColorLib, ENDSTROKECOLOR

getFillColor

int getFillColor()
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.

Returns:
the current fill color, represented as an integer
See Also:
ColorLib, FILLCOLOR

setFillColor

void setFillColor(int color)
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.

Parameters:
color - the current fill color, represented as an integer
See Also:
ColorLib, FILLCOLOR

getStartFillColor

int getStartFillColor()
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.

Returns:
the starting fill color, represented as an integer
See Also:
ColorLib, STARTFILLCOLOR

setStartFillColor

void setStartFillColor(int color)
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.

Parameters:
color - the starting fill color, represented as an integer
See Also:
ColorLib, STARTFILLCOLOR

getEndFillColor

int getEndFillColor()
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.

Returns:
the ending fill color, represented as an integer
See Also:
ColorLib, ENDFILLCOLOR

setEndFillColor

void setEndFillColor(int color)
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.

Parameters:
color - the ending fill color, represented as an integer
See Also:
ColorLib, ENDFILLCOLOR

getTextColor

int getTextColor()
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.

Returns:
the current text color, represented as an integer
See Also:
ColorLib, TEXTCOLOR

setTextColor

void setTextColor(int color)
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.

Parameters:
color - the current text color, represented as an integer
See Also:
ColorLib, TEXTCOLOR

getStartTextColor

int getStartTextColor()
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.

Returns:
the starting text color, represented as an integer
See Also:
ColorLib, STARTTEXTCOLOR

setStartTextColor

void setStartTextColor(int color)
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.

Parameters:
color - the starting text color, represented as an integer
See Also:
ColorLib, STARTTEXTCOLOR

getEndTextColor

int getEndTextColor()
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.

Returns:
the ending text color, represented as an integer
See Also:
ColorLib, ENDTEXTCOLOR

setEndTextColor

void setEndTextColor(int color)
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.

Parameters:
color - the ending text color, represented as an integer
See Also:
ColorLib, ENDTEXTCOLOR

getSize

double getSize()
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).

Returns:
the current size value
See Also:
SIZE

setSize

void setSize(double size)
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).

Parameters:
size - the current size value
See Also:
SIZE

getStartSize

double getStartSize()
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).

Returns:
the starting size value
See Also:
STARTSIZE

setStartSize

void setStartSize(double size)
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).

Parameters:
size - the starting size value
See Also:
STARTSIZE

getEndSize

double getEndSize()
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).

Returns:
the ending size value
See Also:
ENDSIZE

setEndSize

void setEndSize(double size)
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).

Parameters:
size - the ending size value
See Also:
ENDSIZE

getShape

int getShape()
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.

Returns:
the current shape value
See Also:
SHAPE

setShape

void setShape(int shape)
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.

Parameters:
shape - the shape value to use
See Also:
SHAPE

getStroke

java.awt.BasicStroke getStroke()
Get the current stroke used to draw lines and shape outlines.

Returns:
the stroke used to draw lines and shape outlines

setStroke

void setStroke(java.awt.BasicStroke stroke)
Set the current stroke used to draw lines and shape outlines.

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

getFont

java.awt.Font getFont()
Get the current font for the item. The font is used as the default typeface for drawing text for this item.

Returns:
the current font value
See Also:
FONT

setFont

void setFont(java.awt.Font font)
Set the current font for the item. The font is used as the default typeface for drawing text for this item.

Parameters:
font - the current font value
See Also:
FONT

getStartFont

java.awt.Font getStartFont()
Get the starting font for the item. The font is used as the default typeface for drawing text for this item.

Returns:
the starting font value
See Also:
STARTFONT

setStartFont

void setStartFont(java.awt.Font font)
Set the starting font for the item. The font is used as the default typeface for drawing text for this item.

Parameters:
font - the starting font value
See Also:
STARTFONT

getEndFont

java.awt.Font getEndFont()
Get the ending font for the item. The font is used as the default typeface for drawing text for this item.

Returns:
the ending font value
See Also:
ENDFONT

setEndFont

void setEndFont(java.awt.Font font)
Set the ending font for the item. The font is used as the default typeface for drawing text for this item.

Parameters:
font - the ending font value
See Also:
ENDFONT

getDOI

double getDOI()
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.

Returns:
the DOI value of this item
See Also:
DOI

setDOI

void setDOI(double doi)
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.

Parameters:
doi - the DOI value of this item
See Also:
DOI


Copyright 2007 Regents of the University of California