Packages
 In this topic

*Constructors

*Methods

*Fields

 

Packages   PreviousThis PackageNext
Package com.ms.ui.event   Previous This
Package
Next

 


Class UIActionEvent

public class UIActionEvent extends UIEvent
{
  // Fields
  public static final int ACTION_PERFORMED;

  // Constructors
  public UIActionEvent(Object source, int id, IUIComponent item,
        String command);
  public UIActionEvent(Object source, int id, IUIComponent item,
        String command, int modifiers);

  // Methods
  public String getActionCommand();
  public IUIComponent getActionItem();
  public int getModifiers();
  public String paramString();
}

This class represents the action semantic event.

EventObject
  |
  +--UIBaseEvent
    |
    +--UIEvent
      |
      +--UIActionEvent

Constructors

UIActionEvent

public UIActionEvent(Object source, int id, IUIComponent item,
        String command);

Creates a UIActionEvent object with the specified source object.

ParameterDescription
source The object where the event originated.
id The type of event.
item The item originating the event (command string).
command The command string for this action event.

UIActionEvent

public UIActionEvent(Object source, int id, IUIComponent item,
        String command, int modifiers);

Creates a UIActionEvent object with the specified source object.

ParameterDescription
source The object where the event originated.
id The type of event.
item The item originating the event (command string).
command The command string for this action event.
modifiers The modifiers held down during this action (See UIInputEvent)

Methods

getActionCommand

public String getActionCommand();

Retrieves the command name associated with the action.

Return Value:

Returns the command name associated with the action.

getActionItem

public IUIComponent getActionItem();

Retrieves the IUIComponent item associated with the action.

Return Value:

Returns the component object associated with the action.

getModifiers

public int getModifiers();

Retrieves the modifier keys (or buttons) pressed during the action event.

Return Value:

Returns the modifiers. This can be one or a combination of the following:
SHIFT_MASK CTRL_MASK META_MASK ALT_MASK
BUTTON1_MASK BUTTON2_MASK BUTTON3_MASK

paramString

public String paramString();

This method is used internally by the toString method.

Return Value:

Returns a formatted String object that assists with textual representation of the exception.

Fields

ACTION_PERFORMED
An action performed event type.

upnrm.gif © 1998 Microsoft Corporation. All rights reserved. Terms of use.