java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - adams.gui.core.BasePanel
        
        adams.flow.standalone.ratcontrol.AbstractControlPanel<T>

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

RatControlPanel, RatsControlPanel
```
public abstract class AbstractControlPanel<T extends adams.flow.core.Actor & adams.core.Pausable>
extends adams.gui.core.BasePanel
```
Ancestor for control panels.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field	Description
`protected T`	`m_Actor`	the actor to manage.
`protected adams.gui.core.BaseButton`	`m_ButtonPauseResume`	the button for pausing/resuming.
`protected adams.gui.core.BaseCheckBox`	`m_CheckBoxBulkAction`	the checkbox for bulk actions.
`protected Rats`	`m_Group`	the rats group this belongs to.
`protected RatControl`	`m_Owner`	the owner.
`protected boolean`	`m_SkipBulkActionTrigger`	whether to skip bulk triggers.
`protected boolean`	`m_WrappedUp`	whether the flow has wrapped up.

Fields inherited from class adams.gui.core.BasePanel
m_FileChooser

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 Description

AbstractControlPanel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkBoxBulkActionTrigger(boolean value)`	For custom actions when the bulk action checkbox is selected/unselected.
`protected void`	`finishInit()`	Finishes the initialization.
`T`	`getActor()`	Returns the actor in use.
`protected String`	`getCheckBoxBulkActionToolTipText()`	Returns the tool tip for the bulk action checkbox.
`Rats`	`getGroup()`	Returns the Rats group this control belongs to.
`RatControl`	`getOwner()`	Returns the RatControl actor this control belongs to.
`protected void`	`initGUI()`	Initializes the widgets.
`protected void`	`initialize()`	Initializes the member variables.
`boolean`	`isBulkActionEnabled()`	Checks whether bulk action is enabled.
`boolean`	`isChecked()`	Checks whether bulk action checkbox is selected.
`boolean`	`isPausable()`	Returns whether the control panel is enabled.
`void`	`pause()`	Pauses the rat.
`void`	`pauseOrResume()`	Pauses/resumes the rat.
`void`	`resume()`	Resumes the rat.
`void`	`setActor(T value)`	Sets the actor to manage.
`void`	`setBulkActionEnabled(boolean value)`	Sets whether bulk action is enabled.
`void`	`setChecked(boolean value)`	Sets the selected state of the bulk action checkbox.
`void`	`setChecked(boolean value, boolean trigger)`	Sets the selected state of the bulk action checkbox.
`void`	`setGroup(Rats value)`	Sets the Rats groups this control belongs to.
`void`	`setOwner(RatControl value)`	Sets the RatControl actor this control belongs to.
`void`	`setPausable(boolean value)`	Sets the "pauseable" state of the control panel.
`void`	`updateButtons()`	Updates the state of the buttons.
`void`	`wrapUp()`	Disables the button.

Methods inherited from class adams.gui.core.BasePanel
afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, main, printErrorMessage, printException, saveComponent, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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
  - m_Owner
```
protected RatControl m_Owner
```
    the owner.
  - m_Group
```
protected Rats m_Group
```
    the rats group this belongs to.
  - m_Actor
```
protected T extends adams.flow.core.Actor & adams.core.Pausable m_Actor
```
    the actor to manage.
  - m_CheckBoxBulkAction
```
protected adams.gui.core.BaseCheckBox m_CheckBoxBulkAction
```
    the checkbox for bulk actions.
  - m_ButtonPauseResume
```
protected adams.gui.core.BaseButton m_ButtonPauseResume
```
    the button for pausing/resuming.
  - m_SkipBulkActionTrigger
```
protected boolean m_SkipBulkActionTrigger
```
    whether to skip bulk triggers.
  - m_WrappedUp
```
protected boolean m_WrappedUp
```
    whether the flow has wrapped up.
- Constructor Detail
  - AbstractControlPanel
```
public AbstractControlPanel()
```
- Method Detail
  - initialize
```
protected void initialize()
```
    Initializes the member variables.
    
    Overrides:
    
    initialize in class adams.gui.core.BasePanel
  - initGUI
```
protected void initGUI()
```
    Initializes the widgets.
    
    Overrides:
    
    initGUI in class adams.gui.core.BasePanel
  - finishInit
```
protected void finishInit()
```
    Finishes the initialization.
    
    Overrides:
    
    finishInit in class adams.gui.core.BasePanel
  - setOwner
```
public void setOwner(RatControl value)
```
    Sets the RatControl actor this control belongs to.
    
    Parameters:
    
    value - the owner
  - getOwner
```
public RatControl getOwner()
```
    Returns the RatControl actor this control belongs to.
    
    Returns:
    
    the owner
  - setGroup
```
public void setGroup(Rats value)
```
    Sets the Rats groups this control belongs to.
    
    Parameters:
    
    value - the group
  - getGroup
```
public Rats getGroup()
```
    Returns the Rats group this control belongs to.
    
    Returns:
    
    the group
  - setActor
```
public void setActor(T value)
```
    Sets the actor to manage.
    
    Parameters:
    
    value - the actor
  - getActor
```
public T getActor()
```
    Returns the actor in use.
    
    Returns:
    
    the actor
  - getCheckBoxBulkActionToolTipText
```
protected String getCheckBoxBulkActionToolTipText()
```
    Returns the tool tip for the bulk action checkbox.
    Default implementation is null.
    
    Returns:
    
    the tip text
  - checkBoxBulkActionTrigger
```
protected void checkBoxBulkActionTrigger(boolean value)
```
    For custom actions when the bulk action checkbox is selected/unselected.
    Default implementation does nothing.
    
    Parameters:
    
    value - whether to check or uncheck
  - isBulkActionEnabled
```
public boolean isBulkActionEnabled()
```
    Checks whether bulk action is enabled.
    
    Returns:
    
    true if enabled
  - setBulkActionEnabled
```
public void setBulkActionEnabled(boolean value)
```
    Sets whether bulk action is enabled.
    
    Parameters:
    
    value - true if enabled
  - isChecked
```
public boolean isChecked()
```
    Checks whether bulk action checkbox is selected. Only works if isBulkActionEnabled().
    
    Returns:
    
    true if checked
    
    See Also:
    
    isBulkActionEnabled()
  - setChecked
```
public void setChecked(boolean value)
```
    Sets the selected state of the bulk action checkbox. Only works if isBulkActionEnabled().
    
    Parameters:
    
    value - true if to check
    
    See Also:
    
    isBulkActionEnabled()
  - setChecked
```
public void setChecked(boolean value,
                       boolean trigger)
```
    Sets the selected state of the bulk action checkbox. Only works if isBulkActionEnabled().
    
    Parameters:
    
    value - true if to check
    
    See Also:
    
    isBulkActionEnabled()
  - pause
```
public void pause()
```
    Pauses the rat.
  - resume
```
public void resume()
```
    Resumes the rat.
  - pauseOrResume
```
public void pauseOrResume()
```
    Pauses/resumes the rat.
  - updateButtons
```
public void updateButtons()
```
    Updates the state of the buttons.
  - setPausable
```
public void setPausable(boolean value)
```
    Sets the "pauseable" state of the control panel.
    
    Parameters:
    
    value - true if to enable
  - isPausable
```
public boolean isPausable()
```
    Returns whether the control panel is enabled.
    
    Returns:
    
    true if enabled
  - wrapUp
```
public void wrapUp()
```
    Disables the button.

Class AbstractControlPanel<T extends adams.flow.core.Actor & adams.core.Pausable>

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 adams.gui.core.BasePanel

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 adams.gui.core.BasePanel

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

m_Owner

m_Group

m_Actor

m_CheckBoxBulkAction

m_ButtonPauseResume

m_SkipBulkActionTrigger

m_WrappedUp

Constructor Detail

AbstractControlPanel

Method Detail

initialize

initGUI

finishInit

setOwner

getOwner

setGroup

getGroup

setActor

getActor

getCheckBoxBulkActionToolTipText

checkBoxBulkActionTrigger

isBulkActionEnabled

setBulkActionEnabled

isChecked

setChecked

setChecked

pause

resume

pauseOrResume

updateButtons

setPausable

isPausable

wrapUp