com.levigo.jadice.appbase.instruction

Class PanInstruction

java.lang.Object

com.levigo.jadice.appbase.instruction.PanInstruction

All Implemented Interfaces:

Instruction

public class PanInstruction
extends Object
implements Instruction

A simple Instruction which instructs the executor to pan the view to a specific point.

Note
If it is desired to pan and zoom, the order of the PanInstruction and ZoomInstruction inside the InstructionChain might be relevant.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
PanInstruction(Point2D panPoint) Creates a new PanInstruction for the given pan point.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Point2D	getPanPoint() Returns the point to pan to.
String	getType()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

PanInstruction

public PanInstruction(Point2D panPoint)

Creates a new PanInstruction for the given pan point. The point is expected to provide screen coordinates in Document units.

Parameters:

panPoint - the point to pan to

Method Detail

getPanPoint

public Point2D getPanPoint()

Returns the point to pan to. The point describes screen coordinates in document units.

Returns:

the pan point (never null)

getType

public String getType()

Specified by:

getType in interface Instruction

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object