Cytoscape 3.0.0-alpha8-SNAPSHOT API

org.cytoscape.work.swing
Interface SubmenuTunableHandler

All Superinterfaces:
TunableHandler

public interface SubmenuTunableHandler
extends TunableHandler

A TunableHandler specifically for generating dynamic submenus.


Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary
 void chosenMenu(String menuName)
          This method will be called when a submenu is chosen.
 JMenuItem getSubmenuItem()
          Returns the dynamically created submenu item that will be used by DynamicSubmenusListener.
 void setExecutionParams(DialogTaskManager dtm, TaskFactory tf)
          Because clicking on a submenu is already an "action" we need to be able actually tell the handler which task to execute and how.
 
Methods inherited from interface org.cytoscape.work.TunableHandler
controlsMutuallyExclusiveNestedChildren, dependsOn, getChildKey, getDescription, getGroups, getName, getParams, getQualifiedName, getType, getValue, handle, listenForChange, setValue
 

Method Detail

getSubmenuItem

JMenuItem getSubmenuItem()
Returns the dynamically created submenu item that will be used by DynamicSubmenusListener.

Returns:
the dynamically created submenu item that will be used by DynamicSubmenusListener.

chosenMenu

void chosenMenu(String menuName)
This method will be called when a submenu is chosen. The intent is for this method to then set the value in the ListSingleSelection object.

Parameters:
menuName - The name of the menu selected.

setExecutionParams

void setExecutionParams(DialogTaskManager dtm,
                        TaskFactory tf)
Because clicking on a submenu is already an "action" we need to be able actually tell the handler which task to execute and how.

Parameters:
dtm - The DialogTaskManager to be used to execute the TaskFactory.
tf - The TaskFactory to be executed.

Cytoscape 3.0.0-alpha8-SNAPSHOT API

Copyright 2011 Cytoscape Consortium. All rights reserved.