prefuse.visual.expression
Class HoverPredicate

java.lang.Object
  prefuse.data.expression.AbstractExpression
      prefuse.data.expression.ColumnExpression
          prefuse.visual.expression.HoverPredicate

All Implemented Interfaces:

java.util.EventListener, ExpressionListener, Expression, Function, Predicate

public class HoverPredicate
extends ColumnExpression
implements Predicate, Function

Expression that indicates if an item is currently under the mouse pointer.

Author:

jeffrey heer

Field Summary

static Predicate	FALSE Convenience instance for the hover == false case.
static Predicate	TRUE Convenience instance for the hover == true case.

Fields inherited from class prefuse.data.expression.ColumnExpression

m_field

Fields inherited from interface prefuse.data.expression.Function

VARARGS

Constructor Summary

HoverPredicate()
Create a new HoverPredicate.

Method Summary

void	addParameter(Expression e) Add a parameter value sub-expression to this function.
java.lang.String	getName() Get the name of this function.
int	getParameterCount() Get the maximum number of parameters accepted by this Function.
java.lang.String	toString()

Methods inherited from class prefuse.data.expression.ColumnExpression

get, getBoolean, getColumnName, getDouble, getFloat, getInt, getLong, getType

Methods inherited from class prefuse.data.expression.AbstractExpression

addChildListeners, addExpressionListener, expressionChanged, fireExpressionChange, hasListeners, removeChildListeners, removeExpressionListener, visit

Methods inherited from class java.lang.Object

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

Methods inherited from interface prefuse.data.expression.Expression

addExpressionListener, get, getBoolean, getDouble, getFloat, getInt, getLong, getType, removeExpressionListener, visit

Field Detail

TRUE

public static final Predicate TRUE

Convenience instance for the hover == true case.

FALSE

public static final Predicate FALSE

Convenience instance for the hover == false case.

Constructor Detail

HoverPredicate

public HoverPredicate()

Create a new HoverPredicate.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Function

Get the name of this function.

Specified by:

getName in interface Function

Returns:

the function name

See Also:

Function.getName()

addParameter

public void addParameter(Expression e)

Description copied from interface: Function

Add a parameter value sub-expression to this function.

Specified by:

addParameter in interface Function

Parameters:

e - the parameter sub-expression

See Also:

Function.addParameter(prefuse.data.expression.Expression)

getParameterCount

public int getParameterCount()

Description copied from interface: Function

Get the maximum number of parameters accepted by this Function.

Specified by:

getParameterCount in interface Function

Returns:

the maximum number of parametes accepted, or Function.VARARGS is the number is variable.

See Also:

Function.getParameterCount()

toString

public java.lang.String toString()

Overrides:

toString in class ColumnExpression

See Also:

Object.toString()