org.cytoscape.work.swing.util

Class UserAction

java.lang.Object

org.cytoscape.work.swing.util.UserAction

public final class UserAction
extends Object

Support for a user initiated action

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: work-swing-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>work-swing-api</artifactId>
</dependency>

Constructor Summary

Constructors

Constructor and Description
UserAction(ActionListener actionListener) Creates a new UserAction object.

Method Summary

Modifier and Type	Method and Description
ActionListener	getActionListener()
boolean	getEnabled()
void	setActionListener(ActionListener actionListener)
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserAction

public UserAction(ActionListener actionListener)

Creates a new UserAction object. This object is meant to be used by the Cytoscape Tunable mechanism. The Tunable mechanism will display this as a button on the GUI;

 example :
 
 
 class MyClass implements ActionListener {

Parameters:

actionListener - the ActionListener that will be invoked when the user selects this action

Method Detail

getActionListener

public ActionListener getActionListener()

setActionListener

public void setActionListener(ActionListener actionListener)

getEnabled

public boolean getEnabled()

setEnabled

public void setEnabled(boolean enabled)