prefuse.action
Class GroupAction

java.lang.Object
  extended by prefuse.activity.Activity
      extended by prefuse.action.Action
          extended by prefuse.action.GroupAction
Direct Known Subclasses:
FisheyeTreeFilter, GraphDistanceFilter, ItemAction, Layout, VisibilityAnimator, VisibilityFilter

public abstract class GroupAction
extends Action

An Action that can be parameterized to process a particular group of items.

Author:
jeffrey heer

Field Summary
protected  java.lang.String m_group
          A reference to the group to be processed by this Action
 
Fields inherited from class prefuse.action.Action
m_vis
 
Fields inherited from class prefuse.activity.Activity
DEFAULT_STEP_TIME, INFINITY
 
Constructor Summary
GroupAction()
          Create a new GroupAction that processes all groups.
GroupAction(java.lang.String group)
          Create a new GroupAction that processes the specified group.
GroupAction(java.lang.String group, long duration)
          Create a new GroupAction that processes the specified group.
GroupAction(java.lang.String group, long duration, long stepTime)
          Create a new GroupAction that processes the specified group.
GroupAction(Visualization vis)
          Create a new GroupAction that processes all groups.
GroupAction(Visualization vis, long duration)
          Create a new GroupAction that processes all groups.
GroupAction(Visualization vis, long duration, long stepTime)
          Create a new GroupAction that processes all groups.
GroupAction(Visualization vis, java.lang.String group)
          Create a new GroupAction that processes the specified group.
GroupAction(Visualization vis, java.lang.String group, long duration)
          Create a new GroupAction that processes the specified group.
GroupAction(Visualization vis, java.lang.String group, long duration, long stepTime)
          Create a new GroupAction that processes the specified group.
 
Method Summary
 java.lang.String getGroup()
          Get the name of the group to be processed by this Action.
abstract  void run(double frac)
          Runs this Action, triggering whatever processing this Action performs.
 void setGroup(java.lang.String group)
          Sets the name of the group to be processed by this Action.
 
Methods inherited from class prefuse.action.Action
getVisualization, run, setVisualization
 
Methods inherited from class prefuse.activity.Activity
addActivityListener, alwaysRunAfter, cancel, fireActivityCancelled, fireActivityFinished, fireActivityScheduled, fireActivityStarted, fireActivityStepped, getDuration, getNextTime, getPace, getPacingFunction, getStartTime, getStepTime, getStopTime, isEnabled, isRunning, isScheduled, removeActivityListener, run, runAfter, runAt, setDuration, setEnabled, setPacingFunction, setStartTime, setStepTime
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_group

protected java.lang.String m_group
A reference to the group to be processed by this Action

Constructor Detail

GroupAction

public GroupAction()
Create a new GroupAction that processes all groups.

See Also:
Visualization.ALL_ITEMS

GroupAction

public GroupAction(Visualization vis)
Create a new GroupAction that processes all groups.

Parameters:
vis - the Visualization to process
See Also:
Visualization.ALL_ITEMS

GroupAction

public GroupAction(Visualization vis,
                   long duration)
Create a new GroupAction that processes all groups.

Parameters:
vis - the Visualization to process
duration - the duration of this Action
See Also:
Visualization.ALL_ITEMS

GroupAction

public GroupAction(Visualization vis,
                   long duration,
                   long stepTime)
Create a new GroupAction that processes all groups.

Parameters:
vis - the Visualization to process
duration - the duration of this Action
stepTime - the time to wait between invocations of this Action
See Also:
Visualization.ALL_ITEMS

GroupAction

public GroupAction(java.lang.String group)
Create a new GroupAction that processes the specified group.

Parameters:
group - the name of the group to process

GroupAction

public GroupAction(java.lang.String group,
                   long duration)
Create a new GroupAction that processes the specified group.

Parameters:
group - the name of the group to process
duration - the duration of this Action

GroupAction

public GroupAction(java.lang.String group,
                   long duration,
                   long stepTime)
Create a new GroupAction that processes the specified group.

Parameters:
group - the name of the group to process
duration - the duration of this Action
stepTime - the time to wait between invocations of this Action

GroupAction

public GroupAction(Visualization vis,
                   java.lang.String group)
Create a new GroupAction that processes the specified group.

Parameters:
vis - the Visualization to process
group - the name of the group to process

GroupAction

public GroupAction(Visualization vis,
                   java.lang.String group,
                   long duration)
Create a new GroupAction that processes the specified group.

Parameters:
vis - the Visualization to process
group - the name of the group to process
duration - the duration of this Action

GroupAction

public GroupAction(Visualization vis,
                   java.lang.String group,
                   long duration,
                   long stepTime)
Create a new GroupAction that processes the specified group.

Parameters:
vis - the Visualization to process
group - the name of the group to process
duration - the duration of this Action
stepTime - the time to wait between invocations of this Action
Method Detail

getGroup

public java.lang.String getGroup()
Get the name of the group to be processed by this Action.

Returns:
the name of the group to process

setGroup

public void setGroup(java.lang.String group)
Sets the name of the group to be processed by this Action.

Parameters:
group - the name of the group to process

run

public abstract void run(double frac)
Description copied from class: Action
Runs this Action, triggering whatever processing this Action performs. Subclass this method to create custom Actions.

Specified by:
run in class Action
Parameters:
frac - the fraction of this Action's duration that has elapsed.
See Also:
Action.run(double)


Copyright © 2007 Regents of the University of California