org.controlsfx.control.action

Class AnnotatedAction

java.lang.Object

org.controlsfx.control.action.Action

org.controlsfx.control.action.AnnotatedAction

All Implemented Interfaces:

java.util.EventListener, javafx.event.EventHandler<javafx.event.ActionEvent>

Direct Known Subclasses:

AnnotatedCheckAction

public class AnnotatedAction
extends Action

An action that invokes a method that has been annotated with ActionProxy. These actions are created via ActionMap.register(java.lang.Object), which delegates the actual instantiation to an AnnotatedActionFactory. Note that this class maintains a WeakReference to the supplied target object, so the existence of an AnnotatedAction instance will not prevent the target from being garbage-collected.

Property Summary

Properties inherited from class org.controlsfx.control.action.Action

accelerator, disabled, graphic, longText, selected, style, text

Constructor Summary

Constructors

Constructor and Description
AnnotatedAction(java.lang.String text, java.lang.reflect.Method method, java.lang.Object target) Instantiates an action that will call the specified method on the specified target.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getTarget() Returns the target object (the object on which the annotated method will be called).
protected void	handleAction(javafx.event.ActionEvent ae) Handle the action-event by invoking the annotated method on the target object.
protected void	handleActionException(javafx.event.ActionEvent ae, java.lang.Throwable ex) Called if the annotated method throws an exception when invoked.
java.lang.String	toString() Overridden to return the text of this action.

Methods inherited from class org.controlsfx.control.action.Action

acceleratorProperty, disabledProperty, getAccelerator, getEventHandler, getGraphic, getLongText, getProperties, getStyle, getStyleClass, getText, graphicProperty, handle, isDisabled, isSelected, lock, longTextProperty, selectedProperty, setAccelerator, setDisabled, setEventHandler, setGraphic, setLongText, setSelected, setStyle, setText, styleProperty, textProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedAction

public AnnotatedAction(java.lang.String text,
                       java.lang.reflect.Method method,
                       java.lang.Object target)

Instantiates an action that will call the specified method on the specified target.

Method Detail

getTarget

public java.lang.Object getTarget()

Returns the target object (the object on which the annotated method will be called).

Returns:

The target object, or null if the target object has been garbage-collected.

handleAction

protected void handleAction(javafx.event.ActionEvent ae)

Handle the action-event by invoking the annotated method on the target object. If an exception is thrown, then the default implementation of this method will call handleActionException().

handleActionException

protected void handleActionException(javafx.event.ActionEvent ae,
                                     java.lang.Throwable ex)

Called if the annotated method throws an exception when invoked. The default implementation of this method simply prints the stack trace of the specified exception.

toString

public java.lang.String toString()

Overridden to return the text of this action.

Overrides:

toString in class java.lang.Object