VisibleLayout (interruptible-weka 0.1.4 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - weka.gui.knowledgeflow.VisibleLayout

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
```
public class VisibleLayout
extends javax.swing.JPanel
```
Panel that wraps a flow and makes it visible in the KnowledgeFlow, along with it's associated log panel

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`VisibleLayout.KFLogPanel` Small subclass of LogPanel for use by layouts
`protected static class`	`VisibleLayout.LayoutOperation` Editing operations on the layout

Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`LAYOUT_HEIGHT` the flow layout height
`protected static int`	`LAYOUT_WIDTH` the flow layout width
`protected java.lang.String`	`m_editConnection` The name of the user-selected connection if the user has initiated a connection from a source step (stored in m_editStep)
`protected StepVisual`	`m_editStep` Reference to the step being edited (if any)
`protected Environment`	`m_env` Environment variables to use
`protected java.io.File`	`m_filePath` Current path on disk for this flow
`protected Flow`	`m_flow`
`protected FlowExecutor`	`m_flowExecutor` The flow executor used to execute the flow
`protected boolean`	`m_hasBeenEdited` True if the flow has been edited, but not yet saved
`protected boolean`	`m_isExecuting` True if this flow is executing
`protected LayoutPanel`	`m_layout` The panel used to render the flow
`protected VisibleLayout.KFLogPanel`	`m_logPanel` The log panel to use for this layout
`protected MainKFPerspective`	`m_mainPerspective` A reference to the main perspective
`protected java.util.List<StepVisual>`	`m_renderGraph` The steps to be rendered on this layout
`protected java.util.List<StepVisual>`	`m_selectedSteps` Keeps track of any highlighted steps on the canvas
`protected java.util.Stack<java.io.File>`	`m_undoBuffer` Keeps track of the undo buffer for this flow
`protected VisibleLayout.LayoutOperation`	`m_userOpp` The current layout operation
`protected int`	`m_zoomSetting` Current zoom setting for this layout
`protected static int`	`SCROLLBAR_INCREMENT` The scrollbar increment of the layout scrollpane

Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

VisibleLayout(MainKFPerspective mainPerspective)
Constructor

Constructors
Constructor and Description
`VisibleLayout(MainKFPerspective mainPerspective)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.List<StepVisual>`	`addAll(java.util.List<StepManagerImpl> steps)` Add all the supplied steps to the flow managed by this layout
`protected java.util.List<StepVisual>`	`addAll(java.util.List<StepManagerImpl> steps, boolean revalidate)` Add all the supplied steps to the flow managed by this layout
`protected void`	`addStep(StepManagerImpl manager, int x, int y)` Add the supplied step to the flow managed by this layout
`protected void`	`addUndoPoint()` Add an undo point
`void`	`connectSteps(StepManagerImpl source, StepManagerImpl target, java.lang.String connectionType)` Connect the supplied source step to the supplied target step using the specified connection type
`protected void`	`copySelectedStepsToClipboard()` Copies the currently selected list of steps to the global clipboard
`protected void`	`copyStepsToClipboard(java.util.List<StepVisual> steps)` Copies the supplied list of steps to the global clipboard
`java.lang.String`	`environmentSubstitute(java.lang.String source)`
`void`	`executeFlow(boolean sequential)` Execute the flow managed by this layout
`protected java.util.Map<java.lang.String,java.util.List<StepManagerImpl[]>>`	`findClosestConnections(java.awt.Point point, int delta)` Find all connections within delta of the supplied point
`protected StepVisual`	`findStep(java.awt.Point p)` Find the first step whose bounds enclose the supplied point
`protected java.util.List<StepVisual>`	`findSteps(java.awt.Rectangle boundingBox)` Find a list of steps that exist within the supplied bounding box
`protected java.util.List<StepManagerImpl>`	`findStepsThatCanAcceptConnection(java.lang.String connectionName)` Find a list of steps in the flow that can accept the supplied connection type
`protected java.lang.String`	`getEditConnection()` If the user has initiated the connection process, then this method returns the name of the connection involved
`boolean`	`getEdited()` Get whether this flow has been altered since the last save operation
`protected StepVisual`	`getEditStep()` Get the step currently being "edited".
`Environment`	`getEnvironment()` Get the environment variables being used by this layout
`java.io.File`	`getFilePath()` Get the current path (if any) of the flow being edited in this layout
`Flow`	`getFlow()` Get the flow being edited by this layout
`FlowExecutor`	`getFlowExecutor()` Get the `FlowExecutor` being used for execution of this flow
`protected VisibleLayout.LayoutOperation`	`getFlowLayoutOperation()` Get the current flow edit operation
`VisibleLayout.KFLogPanel`	`getLogPanel()` Get the log panel in use by this layout
`protected MainKFPerspective`	`getMainPerspective()` Get the main perspective that owns this layout
`protected java.util.List<StepVisual>`	`getRenderGraph()` Get a list of the steps (wrapped in `StepVisual` instances) that make up the flow rendered/edited by this panel
`protected java.util.List<StepVisual>`	`getSelectedSteps()` Get the list of selected steps.
`protected int`	`getUndoBufferSize()` Get the number of entries in the undo stack
`int`	`getZoomSetting()` Get the current zoom setting for this layout
`protected void`	`initiateAddNote()` Initiate the process of adding a note to the layout
`boolean`	`isExecuting()` Returns true if the flow managed by this layout is currently executing
`protected void`	`loadLayout(java.io.File fFile, boolean isUndo)` Load a flow into this layout
`protected int`	`numSteps()` Get the number of steps in the layout
`protected void`	`pasteFromClipboard(int x, int y)` Pastes the contents (if any) of the global clipboard to this layout
`protected void`	`popAndLoadUndo()` Pop an undo point and load the flow it encapsulates
`protected boolean`	`previousConn(java.util.Map<java.lang.String,java.util.List<StepManager>> outConns, StepManagerImpl target, int index)` Returns true if there is a previous (prior to index) connection to the supplied target step in the supplied map of connections.
`protected void`	`removeSelectedSteps()` Removes the currently selected list of steps from the layout
`protected void`	`removeStep(StepVisual step)` Remove a step from the flow displayed/edited by this layout
`protected void`	`renameStep(java.lang.String oldName, java.lang.String newName)` Rename a step
`protected void`	`saveLayout(boolean showDialog)` Save the flow managed by this layout
`static java.lang.String`	`serializeStepsToJSON(java.util.List<StepVisual> steps, java.lang.String name)` Utility method to serialize a list of steps (encapsulated in StepVisuals) to a JSON flow.
`protected void`	`setEditConnection(java.lang.String connName)` Set the name of the connection involved in a connection operation
`void`	`setEdited(boolean edited)` Set the edited status of this flow
`protected void`	`setEditStep(StepVisual step)` Set the step to "edit"
`void`	`setEnvironment(Environment env)` Set the environment variables to use with this layout
`void`	`setFilePath(java.io.File path)` Set the file path for the flow being edited by this layout
`void`	`setFlow(Flow flow)` Set the flow to edit in this layout
`void`	`setFlowExecutor(FlowExecutor executor)` Set the `FlowExcecutor` to use for executing the flow
`protected void`	`setFlowLayoutOperation(VisibleLayout.LayoutOperation mode)` Set the current flow edit operation
`protected void`	`setSelectedSteps(java.util.List<StepVisual> selected)` Set a list of steps to be considered "selected".
`void`	`setZoomSetting(int zoom)` Set the current zoom setting for this layout
`protected void`	`snapSelectedToGrid()` Snap the selected steps (if any) to the grid
`void`	`stopFlow()` Stop the flow from executing

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LAYOUT_WIDTH
```
protected static final int LAYOUT_WIDTH
```
    the flow layout width
    
    See Also:
    
    Constant Field Values
  - LAYOUT_HEIGHT
```
protected static final int LAYOUT_HEIGHT
```
    the flow layout height
    
    See Also:
    
    Constant Field Values
  - SCROLLBAR_INCREMENT
```
protected static final int SCROLLBAR_INCREMENT
```
    The scrollbar increment of the layout scrollpane
    
    See Also:
    
    Constant Field Values
  - m_flow
```
protected Flow m_flow
```
  - m_logPanel
```
protected VisibleLayout.KFLogPanel m_logPanel
```
    The log panel to use for this layout
  - m_zoomSetting
```
protected int m_zoomSetting
```
    Current zoom setting for this layout
  - m_filePath
```
protected java.io.File m_filePath
```
    Current path on disk for this flow
  - m_selectedSteps
```
protected java.util.List<StepVisual> m_selectedSteps
```
    Keeps track of any highlighted steps on the canvas
  - m_undoBuffer
```
protected java.util.Stack<java.io.File> m_undoBuffer
```
    Keeps track of the undo buffer for this flow
  - m_hasBeenEdited
```
protected boolean m_hasBeenEdited
```
    True if the flow has been edited, but not yet saved
  - m_flowExecutor
```
protected FlowExecutor m_flowExecutor
```
    The flow executor used to execute the flow
  - m_env
```
protected Environment m_env
```
    Environment variables to use
  - m_isExecuting
```
protected boolean m_isExecuting
```
    True if this flow is executing
  - m_mainPerspective
```
protected MainKFPerspective m_mainPerspective
```
    A reference to the main perspective
  - m_renderGraph
```
protected java.util.List<StepVisual> m_renderGraph
```
    The steps to be rendered on this layout
  - m_userOpp
```
protected VisibleLayout.LayoutOperation m_userOpp
```
    The current layout operation
  - m_layout
```
protected LayoutPanel m_layout
```
    The panel used to render the flow
  - m_editStep
```
protected StepVisual m_editStep
```
    Reference to the step being edited (if any)
  - m_editConnection
```
protected java.lang.String m_editConnection
```
    The name of the user-selected connection if the user has initiated a connection from a source step (stored in m_editStep)
- Constructor Detail
  - VisibleLayout
```
public VisibleLayout(MainKFPerspective mainPerspective)
```
    Constructor
    
    Parameters:
    
    mainPerspective - the main Knowledge Flow perspective
- Method Detail
  - getRenderGraph
```
protected java.util.List<StepVisual> getRenderGraph()
```
    Get a list of the steps (wrapped in StepVisual instances) that make up the flow rendered/edited by this panel
    
    Returns:
    
    a list of steps
  - getMainPerspective
```
protected MainKFPerspective getMainPerspective()
```
    Get the main perspective that owns this layout
    
    Returns:
    
    the main perspective
  - getEditStep
```
protected StepVisual getEditStep()
```
    Get the step currently being "edited". Returns null if no step is being edited
    
    Returns:
    
    the step being edited
  - setEditStep
```
protected void setEditStep(StepVisual step)
```
    Set the step to "edit"
    
    Parameters:
    
    step - the step to edit
  - getEditConnection
```
protected java.lang.String getEditConnection()
```
    If the user has initiated the connection process, then this method returns the name of the connection involved
    
    Returns:
    
    the name of the connection if the user has initiated the connection process
  - setEditConnection
```
protected void setEditConnection(java.lang.String connName)
```
    Set the name of the connection involved in a connection operation
    
    Parameters:
    
    connName - the name of the connection
  - getSelectedSteps
```
protected java.util.List<StepVisual> getSelectedSteps()
```
    Get the list of selected steps. The list will be empty if there are no selected (highlighted) steps on the canvas.
    
    Returns:
    
    the list of selected steps
  - setSelectedSteps
```
protected void setSelectedSteps(java.util.List<StepVisual> selected)
```
    Set a list of steps to be considered "selected". Setting an empty list clears any current selection.
    
    Parameters:
    
    selected - a list of steps to be considered as selected
  - removeSelectedSteps
```
protected void removeSelectedSteps()
                            throws WekaException
```
    Removes the currently selected list of steps from the layout
    
    Throws:
    
    WekaException - if a problem occurs
  - copySelectedStepsToClipboard
```
protected void copySelectedStepsToClipboard()
                                     throws WekaException
```
    Copies the currently selected list of steps to the global clipboard
    
    Throws:
    
    WekaException - if a problem occurs
  - copyStepsToClipboard
```
protected void copyStepsToClipboard(java.util.List<StepVisual> steps)
                             throws WekaException
```
    Copies the supplied list of steps to the global clipboard
    
    Parameters:
    
    steps - the steps to copy to the clipboard
    
    Throws:
    
    WekaException - if a problem occurs
  - pasteFromClipboard
```
protected void pasteFromClipboard(int x,
                                  int y)
                           throws WekaException
```
    Pastes the contents (if any) of the global clipboard to this layout
    
    Parameters:
    
    x - the x coordinate to paste at
    
    y - the y cooridinate to paste at
    
    Throws:
    
    WekaException - if a problem occurs
  - addUndoPoint
```
protected void addUndoPoint()
```
    Add an undo point
  - getUndoBufferSize
```
protected int getUndoBufferSize()
```
    Get the number of entries in the undo stack
    
    Returns:
    
    the number of entries in the undo stack
  - snapSelectedToGrid
```
protected void snapSelectedToGrid()
```
    Snap the selected steps (if any) to the grid
  - initiateAddNote
```
protected void initiateAddNote()
```
    Initiate the process of adding a note to the layout
  - getFlow
```
public Flow getFlow()
```
    Get the flow being edited by this layout
    
    Returns:
    
    the flow being edited by this layout
  - setFlow
```
public void setFlow(Flow flow)
```
    Set the flow to edit in this layout
    
    Parameters:
    
    flow - the flow to edit in this layout
  - addAll
```
protected java.util.List<StepVisual> addAll(java.util.List<StepManagerImpl> steps)
```
    Add all the supplied steps to the flow managed by this layout
    
    Parameters:
    
    steps - the steps to add
    
    Returns:
    
    a list of all the added steps, where each has been wrapped in an appropriate StepVisual instance.
  - addAll
```
protected java.util.List<StepVisual> addAll(java.util.List<StepManagerImpl> steps,
                                            boolean revalidate)
```
    Add all the supplied steps to the flow managed by this layout
    
    Parameters:
    
    steps - the steps to add
    
    revalidate - true if the GUI should be repainted
    
    Returns:
    
    a list of all the added steps, where each has been wrapped in an appropriate StepVisual instance.
  - addStep
```
protected void addStep(StepManagerImpl manager,
                       int x,
                       int y)
```
    Add the supplied step to the flow managed by this layout
    
    Parameters:
    
    manager - the StepManager instance managing the step to be added
    
    x - the x coordinate to add at
    
    y - the y coordinate to add at
  - connectSteps
```
public void connectSteps(StepManagerImpl source,
                         StepManagerImpl target,
                         java.lang.String connectionType)
```
    Connect the supplied source step to the supplied target step using the specified connection type
    
    Parameters:
    
    source - the StepManager instance managing the source step
    
    target - the StepManager instance managing the target step
    
    connectionType - the connection type to use
  - renameStep
```
protected void renameStep(java.lang.String oldName,
                          java.lang.String newName)
```
    Rename a step
    
    Parameters:
    
    oldName - the old name of the step to rename
    
    newName - the new name to give the step
  - removeStep
```
protected void removeStep(StepVisual step)
                   throws WekaException
```
    Remove a step from the flow displayed/edited by this layout
    
    Parameters:
    
    step - the StepVisual instance wrapping the step to be removed
    
    Throws:
    
    WekaException - if a problem occurs
  - numSteps
```
protected int numSteps()
```
    Get the number of steps in the layout
    
    Returns:
    
    the number of steps in the layout
  - getEnvironment
```
public Environment getEnvironment()
```
    Get the environment variables being used by this layout
    
    Returns:
    
    the environment variables being used by this layout
  - setEnvironment
```
public void setEnvironment(Environment env)
```
    Set the environment variables to use with this layout
    
    Parameters:
    
    env - the environment variables to use
  - environmentSubstitute
```
public java.lang.String environmentSubstitute(java.lang.String source)
```
  - getFlowExecutor
```
public FlowExecutor getFlowExecutor()
```
    Get the FlowExecutor being used for execution of this flow
    
    Returns:
    
    the FlowExecutor in use by this layout
  - setFlowExecutor
```
public void setFlowExecutor(FlowExecutor executor)
```
    Set the FlowExcecutor to use for executing the flow
    
    Parameters:
    
    executor - the FlowExecutor to use for executing the flow in this layout
  - getFilePath
```
public java.io.File getFilePath()
```
    Get the current path (if any) of the flow being edited in this layout
    
    Returns:
    
    the current path on disk of the flow
  - setFilePath
```
public void setFilePath(java.io.File path)
```
    Set the file path for the flow being edited by this layout
    
    Parameters:
    
    path - the path on disk for the flow being edited
  - getLogPanel
```
public VisibleLayout.KFLogPanel getLogPanel()
```
    Get the log panel in use by this layout
    
    Returns:
    
    the log panel
  - getZoomSetting
```
public int getZoomSetting()
```
    Get the current zoom setting for this layout
    
    Returns:
    
    the current zoom setting
  - setZoomSetting
```
public void setZoomSetting(int zoom)
```
    Set the current zoom setting for this layout
    
    Parameters:
    
    zoom - the current zoom setting
  - getEdited
```
public boolean getEdited()
```
    Get whether this flow has been altered since the last save operation
    
    Returns:
    
    true if the flow has been altered
  - setEdited
```
public void setEdited(boolean edited)
```
    Set the edited status of this flow
    
    Parameters:
    
    edited - true if the flow has been altered
  - isExecuting
```
public boolean isExecuting()
```
    Returns true if the flow managed by this layout is currently executing
    
    Returns:
    
    true if the flow is executing
  - getFlowLayoutOperation
```
protected VisibleLayout.LayoutOperation getFlowLayoutOperation()
```
    Get the current flow edit operation
    
    Returns:
    
    the current flow edit operation
  - setFlowLayoutOperation
```
protected void setFlowLayoutOperation(VisibleLayout.LayoutOperation mode)
```
    Set the current flow edit operation
    
    Parameters:
    
    mode - the current flow edit operation
  - executeFlow
```
public void executeFlow(boolean sequential)
                 throws WekaException
```
    Execute the flow managed by this layout
    
    Parameters:
    
    sequential - true if the flow's start points are to be launched sequentially rather than in parallel
    
    Throws:
    
    WekaException - if a problem occurs
  - stopFlow
```
public void stopFlow()
```
    Stop the flow from executing
  - findStep
```
protected StepVisual findStep(java.awt.Point p)
```
    Find the first step whose bounds enclose the supplied point
    
    Parameters:
    
    p - the point
    
    Returns:
    
    the first step in the flow whose visible bounds enclose the supplied point, or null if no such step exists
  - findSteps
```
protected java.util.List<StepVisual> findSteps(java.awt.Rectangle boundingBox)
```
    Find a list of steps that exist within the supplied bounding box
    
    Parameters:
    
    boundingBox - the bounding box to check
    
    Returns:
    
    a list of steps that fall within the bounding box
  - findStepsThatCanAcceptConnection
```
protected java.util.List<StepManagerImpl> findStepsThatCanAcceptConnection(java.lang.String connectionName)
```
    Find a list of steps in the flow that can accept the supplied connection type
    
    Parameters:
    
    connectionName - the type of connection to check for
    
    Returns:
    
    a list of steps that can accept the supplied connection type
  - findClosestConnections
```
protected java.util.Map<java.lang.String,java.util.List<StepManagerImpl[]>> findClosestConnections(java.awt.Point point,
                                                                                                   int delta)
```
    Find all connections within delta of the supplied point
    
    Parameters:
    
    point - the point on the canvas to find steps at
    
    delta - the radius around point for detecting connections
    
    Returns:
    
    a map keyed by connection type name of connected steps. The value is a list of 2 element arrays, where each array contains source and target steps for the connection in question
  - previousConn
```
protected boolean previousConn(java.util.Map<java.lang.String,java.util.List<StepManager>> outConns,
                               StepManagerImpl target,
                               int index)
```
    Returns true if there is a previous (prior to index) connection to the supplied target step in the supplied map of connections.
    
    Parameters:
    
    outConns - the map of connections to check
    
    target - the target step to check for
    
    index - connections to the target prior to this index in the map count
    
    Returns:
    
    true if a previous connection is found
  - saveLayout
```
protected void saveLayout(boolean showDialog)
```
    Save the flow managed by this layout
    
    Parameters:
    
    showDialog - true if a file dialog should be displayed
  - popAndLoadUndo
```
protected void popAndLoadUndo()
```
    Pop an undo point and load the flow it encapsulates
  - loadLayout
```
protected void loadLayout(java.io.File fFile,
                          boolean isUndo)
```
    Load a flow into this layout
    
    Parameters:
    
    fFile - the file containing the flow
    
    isUndo - true if this is an "undo" layout
  - serializeStepsToJSON
```
public static java.lang.String serializeStepsToJSON(java.util.List<StepVisual> steps,
                                                    java.lang.String name)
                                             throws WekaException
```
    Utility method to serialize a list of steps (encapsulated in StepVisuals) to a JSON flow.
    
    Parameters:
    
    steps - the steps to serialize
    
    name - the name to set in the encapsulating Flow before serializing
    
    Returns:
    
    the serialized Flow
    
    Throws:
    
    WekaException - if a problem occurs

Class VisibleLayout

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

LAYOUT_WIDTH

LAYOUT_HEIGHT

SCROLLBAR_INCREMENT

m_flow

m_logPanel

m_zoomSetting

m_filePath

m_selectedSteps

m_undoBuffer

m_hasBeenEdited

m_flowExecutor

m_env

m_isExecuting

m_mainPerspective

m_renderGraph

m_userOpp

m_layout

m_editStep

m_editConnection

Constructor Detail

VisibleLayout

Method Detail

getRenderGraph

getMainPerspective

getEditStep

setEditStep

getEditConnection

setEditConnection

getSelectedSteps

setSelectedSteps

removeSelectedSteps

copySelectedStepsToClipboard

copyStepsToClipboard

pasteFromClipboard

addUndoPoint

getUndoBufferSize

snapSelectedToGrid

initiateAddNote

getFlow

setFlow

addAll

addAll

addStep

connectSteps

renameStep

removeStep

numSteps

getEnvironment

setEnvironment

environmentSubstitute

getFlowExecutor

setFlowExecutor

getFilePath

setFilePath

getLogPanel

getZoomSetting

setZoomSetting

getEdited

setEdited

isExecuting

getFlowLayoutOperation

setFlowLayoutOperation