com.jidesoft.document
Class DocumentComponentEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          com.jidesoft.document.DocumentComponentEvent

All Implemented Interfaces:

Serializable

public class DocumentComponentEvent
extends AWTEvent

Event for DocumentComponent.

See Also:

Serialized Form

Field Summary

static int	DOCUMENT_COMPONENT_ACTIVATED The "document component activated" event type.
static int	DOCUMENT_COMPONENT_CLOSED The "document closed" event.
static int	DOCUMENT_COMPONENT_CLOSING The "document is closing" event.
static int	DOCUMENT_COMPONENT_DEACTIVATED The "document component deactivated" event type.
static int	DOCUMENT_COMPONENT_DOCKED The "document docked" event.
static int	DOCUMENT_COMPONENT_FIRST The first number in the range of IDs used for document component events.
static int	DOCUMENT_COMPONENT_FLOATED The "document floating" event.
static int	DOCUMENT_COMPONENT_LAST The last number in the range of IDs used for document component events.
static int	DOCUMENT_COMPONENT_MOVED The "document moved" event.
static int	DOCUMENT_COMPONENT_MOVING The "document is moving" event.
static int	DOCUMENT_COMPONENT_OPENED The "document opened" event.

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

DocumentComponentEvent(DocumentComponent source, int id)
Constructs an DocumentComponentEvent object.

Method Summary

DocumentComponent	getDocumentComponent() Returns the originator of the event.
String	paramString() Returns a parameter string identifying this event.

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_COMPONENT_FIRST

public static final int DOCUMENT_COMPONENT_FIRST

The first number in the range of IDs used for document component events.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_LAST

public static final int DOCUMENT_COMPONENT_LAST

The last number in the range of IDs used for document component events.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_OPENED

public static final int DOCUMENT_COMPONENT_OPENED

The "document opened" event. This event is delivered only the first time the document component is made visible.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_CLOSING

public static final int DOCUMENT_COMPONENT_CLOSING

The "document is closing" event. This event is delivered when the user attempts to close the document component, such as by clicking the document component's close button, or when a program attempts to close the document component by invoking the closeDocument method. When you handle this event, you have a chance to prevent it from closed by setAllowClosing to false.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_CLOSED

public static final int DOCUMENT_COMPONENT_CLOSED

The "document closed" event. This event is delivered after the document component has been closed as the result of a call to the closeDocument.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_ACTIVATED

public static final int DOCUMENT_COMPONENT_ACTIVATED

The "document component activated" event type. This event indicates that keystrokes and mouse clicks are directed towards this document component .

See Also:

Constant Field Values

DOCUMENT_COMPONENT_DEACTIVATED

public static final int DOCUMENT_COMPONENT_DEACTIVATED

The "document component deactivated" event type. This event indicates that keystrokes and mouse clicks are no longer directed to the document component.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_MOVING

public static final int DOCUMENT_COMPONENT_MOVING

The "document is moving" event. This event is delivered when the user attempts to move the document component, such as by dragging the tab of the document component and move it to somewhere else, or when a program attempts to close the document component by invoking the moveDocument method. When you handle this event, you have a chance to prevent it from moved by setAllowMoving to false.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_MOVED

public static final int DOCUMENT_COMPONENT_MOVED

The "document moved" event. This event is delivered after the document component has been moved as the result of a call to the moveDocument.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_DOCKED

public static final int DOCUMENT_COMPONENT_DOCKED

The "document docked" event. This event is delivered after the document component is docked from the floated state to the docked state as the result of a call to the dockDocument.

See Also:

Constant Field Values

DOCUMENT_COMPONENT_FLOATED

public static final int DOCUMENT_COMPONENT_FLOATED

The "document floating" event. This event is delivered after the document component is floated from the docked state to the floated state as the result of a call to the floatDocument.

See Also:

Constant Field Values

Constructor Detail

DocumentComponentEvent

public DocumentComponentEvent(DocumentComponent source,
                              int id)

Constructs an DocumentComponentEvent object.

Parameters:

source - the DocumentComponent object that originated the event

id - an integer indicating the type of event

Method Detail

paramString

public String paramString()

Returns a parameter string identifying this event. This method is useful for event logging and for debugging.

Overrides:

paramString in class AWTEvent

Returns:

a string identifying the event and its attributes

getDocumentComponent

public DocumentComponent getDocumentComponent()

Returns the originator of the event.

Returns:

the document associate with this event