com.levigo.jadice.swing.tool
Class MouseEditEvent

java.lang.Object
  java.util.EventObject
      com.levigo.jadice.swing.tool.EditEvent
          com.levigo.jadice.swing.tool.MouseEditEvent

All Implemented Interfaces:

Serializable

public class MouseEditEvent
extends EditEvent

See Also:

Serialized Form

Field Summary

Fields inherited from class com.levigo.jadice.swing.tool.EditEvent

inputEvent, pageBounds

Fields inherited from class java.util.EventObject

source

Method Summary

int	getButton()
int	getClickCount()
Point2D	getConstrainedDocumentPoint() Return the point in document coordinates.
Point	getConstrainedPoint() Return the point relative to the RenderedPage's origin in screen coordinates.
Point2D	getDocumentPoint() Return the point in document coordinates.
MouseEvent	getInputEvent()
Point	getPoint() Return the point relative to the RenderedPage's origin in screen coordinates.
int	getX()
int	getY()
boolean	isWithinPageBounds()

Methods inherited from class com.levigo.jadice.swing.tool.EditEvent

consume, create, getID, getModifiers, getModifiersEx, getPage, getPageIndex, getPageRenderControls, getRenderedPageBounds, getRenderedSize, getSource, getWhen, hasPageContext, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown, toString

Methods inherited from class java.lang.Object

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

Method Detail

getButton

public int getButton()

See Also:

MouseEvent.getButton()

getClickCount

public int getClickCount()

See Also:

MouseEvent.getClickCount()

getPoint

public Point getPoint()

Return the point relative to the RenderedPage's origin in screen coordinates.

See Also:

MouseEvent.getPoint()

getConstrainedPoint

public Point getConstrainedPoint()

Return the point relative to the RenderedPage's origin in screen coordinates. If the point is outside the rendered page's bounds, the point is constrained to lie within the bounds.

Caveat: Clients must not attempt to call this method unless EditEvent.hasPageContext() returned true.

Throws:

IllegalStateException - if the event does not have a page context

See Also:

MouseEvent.getPoint(), EditEvent.hasPageContext()

getDocumentPoint

public Point2D getDocumentPoint()

Return the point in document coordinates.

Caveat: Clients must not attempt to call this method unless EditEvent.hasPageContext() returned true.

Returns:

a point

Throws:

IllegalStateException - if the event does not have a page context

See Also:

EditEvent.hasPageContext()

getConstrainedDocumentPoint

public Point2D getConstrainedDocumentPoint()

Return the point in document coordinates. If the point is outside the page's bounds, the point is constrained to lie within the bounds.

Caveat: Clients must not attempt to call this method unless EditEvent.hasPageContext() returned true.

Returns:

a point

Throws:

IllegalStateException - if the event does not have a page context

See Also:

EditEvent.hasPageContext()

getX

public int getX()

See Also:

MouseEvent.getX()

getY

public int getY()

See Also:

MouseEvent.getY()

getInputEvent

public MouseEvent getInputEvent()

Specified by:

getInputEvent in class EditEvent

Returns:

the inputEvent

isWithinPageBounds

public boolean isWithinPageBounds()