|
Cytoscape 3.0.0-alpha8-SNAPSHOT API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.cytoscape.view.layout.AbstractLayoutAlgorithmContext
public class AbstractLayoutAlgorithmContext
| Field Summary | |
|---|---|
protected CyNetwork |
network
|
protected boolean |
selectedOnly
Indicates that only selected nodes should be laid out. |
protected Set<View<CyNode>> |
staticNodes
The set of nodes that are |
| Constructor Summary | |
|---|---|
AbstractLayoutAlgorithmContext(boolean supportsSelectedOnly,
Set<Class<?>> supportedNodeAttributes,
Set<Class<?>> supportedEdgeAttributes)
|
|
| Method Summary | |
|---|---|
protected void |
configureLayoutFromSubmenuSelection(ListSingleSelection<String> opts)
|
CyNetworkView |
getNetworkView()
|
Set<View<CyNode>> |
getStaticNodes()
|
ListSingleSelection<String> |
getSubmenuOptions()
Never use this method from within a layout to access the submenu options, instead call the configureLayoutFromSubmenuSelection() method to configure the layout based on menu selection. |
void |
initStaticNodes(CyNetworkView networkView)
Descendants need to call this if they intend to use the "staticNodes" field. |
void |
setLayoutAttribute(String attributeName)
Set the name of the attribute to use for attribute dependent layout algorithms. |
void |
setNetworkView(CyNetworkView networkView)
Sets the network view to be laid out. |
void |
setSelectedOnly(boolean selectedOnly)
Set the flag that indicates that this algorithm should only operate on the currently selected nodes. |
void |
setSubmenuOptions(ListSingleSelection<String> opts)
|
boolean |
useSelectedOnly()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Set<View<CyNode>> staticNodes
protected boolean selectedOnly
protected CyNetwork network
| Constructor Detail |
|---|
public AbstractLayoutAlgorithmContext(boolean supportsSelectedOnly,
Set<Class<?>> supportedNodeAttributes,
Set<Class<?>> supportedEdgeAttributes)
| Method Detail |
|---|
public ListSingleSelection<String> getSubmenuOptions()
public void setSubmenuOptions(ListSingleSelection<String> opts)
protected void configureLayoutFromSubmenuSelection(ListSingleSelection<String> opts)
public void setNetworkView(CyNetworkView networkView)
setNetworkView in interface CyLayoutContextnetworkView - the network view to be laid out.public CyNetworkView getNetworkView()
getNetworkView in interface CyLayoutContextpublic void setLayoutAttribute(String attributeName)
attributeName - The name of the attributepublic void setSelectedOnly(boolean selectedOnly)
selectedOnly - set to "true" if the algorithm should
only apply to selected nodes onlypublic boolean useSelectedOnly()
public final void initStaticNodes(CyNetworkView networkView)
public Set<View<CyNode>> getStaticNodes()
|
Cytoscape 3.0.0-alpha8-SNAPSHOT API | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||