com.guiseframework.platform.web
Class WebActionDepictEvent

java.lang.Object
  java.util.EventObject
      com.globalmentor.event.AbstractEvent
          com.guiseframework.event.AbstractGuiseEvent
              com.guiseframework.platform.AbstractPlatformEvent
                  com.guiseframework.platform.AbstractDepictEvent
                      com.guiseframework.platform.web.AbstractWebDepictEvent
                          com.guiseframework.platform.web.WebActionDepictEvent

All Implemented Interfaces:

com.globalmentor.event.Event, GuiseEvent, DepictEvent, PlatformEvent, PlatformMessage, WebDepictEvent, WebPlatformEvent, WebPlatformMessage, java.io.Serializable

public class WebActionDepictEvent
extends AbstractWebDepictEvent

Indicates that an action has been initiated on the web platform.

Author:

Garret Wilson

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

WebActionDepictEvent(DepictedObject depictedObject, java.lang.String targetID, java.lang.String actionID, int option)
Depicted object, depicted object, target ID, action ID, and option constructor.

Method Summary

java.lang.String	getActionID()
int	getOption()
java.lang.String	getTargetID()

Methods inherited from class com.guiseframework.platform.AbstractDepictEvent

getDepictedObject

Methods inherited from class com.guiseframework.event.AbstractGuiseEvent

getSession

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.guiseframework.platform.DepictEvent

getDepictedObject

Methods inherited from interface com.globalmentor.event.Event

getSource

Constructor Detail

WebActionDepictEvent

public WebActionDepictEvent(DepictedObject depictedObject,
                            java.lang.String targetID,
                            java.lang.String actionID,
                            int option)

Depicted object, depicted object, target ID, action ID, and option constructor.

Parameters:

depictedObject - The depicted object on which the event initially occurred.

targetID - The ID of the component target site, or null if there was no component target.

actionID - The action identifier, or null if this event represents a general action.

option - The zero-based option, such as 0 for a left click or 1 for a right click.

Throws:

java.lang.NullPointerException - if the given context and/or component ID is null.

Method Detail

getTargetID

public java.lang.String getTargetID()

Returns:

The ID of the component target site, or null if there was no component target.

getActionID

public java.lang.String getActionID()

Returns:

The action identifier, or null if this event represents a general action.

getOption

public int getOption()

Returns:

The zero-based option, such as 0 for a left click or 1 for a right click.