Package io.guise.framework.event

Class CommandEvent

java.lang.Object

java.util.EventObject

com.globalmentor.event.AbstractEvent

io.guise.framework.event.AbstractGuiseEvent

io.guise.framework.event.AbstractInputEvent

io.guise.framework.event.AbstractFocusedInputEvent

io.guise.framework.event.CommandEvent

All Implemented Interfaces:

com.globalmentor.event.Event, FocusedInputEvent, GuiseEvent, InputEvent, java.io.Serializable

public class CommandEvent
extends AbstractFocusedInputEvent

A focused event providing information on an input user command.

Author:

Garret Wilson

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
CommandEvent(java.lang.Object source, CommandEvent commandEvent)	Copy constructor that specifies a different source.
CommandEvent(java.lang.Object source, Command command)	Command constructor.
CommandEvent(java.lang.Object source, CommandInput commandInput)	Command input constructor.

Method Summary

Modifier and Type	Method	Description
Command	getCommand()
CommandInput	getInput()

Methods inherited from class io.guise.framework.event.AbstractInputEvent

consume, isConsumed

Methods inherited from class io.guise.framework.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.globalmentor.event.Event

getSource

Methods inherited from interface io.guise.framework.event.GuiseEvent

getSession

Methods inherited from interface io.guise.framework.event.InputEvent

consume, isConsumed

Constructor Detail

CommandEvent

public CommandEvent(java.lang.Object source,
                    Command command)

Command constructor.

Parameters:

source - The object on which the event initially occurred.

command - The command.

Throws:

java.lang.NullPointerException - if the given source and/or command is null.

CommandEvent

public CommandEvent(java.lang.Object source,
                    CommandInput commandInput)

Command input constructor.

Parameters:

source - The object on which the event initially occurred.

commandInput - The command input the properties of which will be copied.

Throws:

java.lang.NullPointerException - if the given source and/or input is null.

CommandEvent

public CommandEvent(java.lang.Object source,
                    CommandEvent commandEvent)

Copy constructor that specifies a different source.

Parameters:

source - The object on which the event initially occurred.

commandEvent - The event the properties of which will be copied.

Throws:

java.lang.NullPointerException - if the given source and/or event is null.

Method Detail

getCommand

public Command getCommand()

Returns:

The command.

getInput

public CommandInput getInput()

Returns:

The input associated with this event, or null if there is no input associated with this event.