sarj
Class ScriptDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by sarj.ScriptDialog
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ScriptDialog
extends javax.swing.JDialog
implements java.awt.event.ActionListener, java.awt.event.FocusListener

Contains details of all time and event based scripts

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes/interfaces inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static java.lang.String EXTENSION_es
           
static java.lang.String EXTENSION_js
           
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ScriptDialog(GUI owner, java.lang.String title, java.lang.String settingsFile)
          Script dialog constructor
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Called as a result of implementing ActionListener
 void addEventScript(java.lang.String name, java.lang.String filename, boolean enabled)
          Adds details of an event script to the event script table
 void focusGained(java.awt.event.FocusEvent e)
          Called as a result of implementing FocusListener
 void focusLost(java.awt.event.FocusEvent e)
          Called as a result of implementing FocusListener
 java.lang.String getFilenameForEvent(java.lang.String eventName)
          Returns the script file path associated with the specified event
 java.lang.Object[][] getTimedScriptDetails()
          Returns the details of all the interval based or specific time based scripts
 boolean isEventEnabled(java.lang.String eventName)
          Returns whether or not the specified event is enabled
 void loadSettings()
          Loads the script dialog settings from the settings file
 void saveSettings()
          Saves the script settings to the settings file
 void setVisible(boolean b)
          Overridden to disable the 'script details' related components
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXTENSION_js

public static final java.lang.String EXTENSION_js
See Also:
Constant Field Values

EXTENSION_es

public static final java.lang.String EXTENSION_es
See Also:
Constant Field Values
Constructor Detail

ScriptDialog

public ScriptDialog(GUI owner,
                    java.lang.String title,
                    java.lang.String settingsFile)
Script dialog constructor

Parameters:
owner - the parent GUI of the dialog
title - the title of the dialog window
settingsFile - the file path of the script settings file to load from and save to
Method Detail

addEventScript

public void addEventScript(java.lang.String name,
                           java.lang.String filename,
                           boolean enabled)
Adds details of an event script to the event script table

Parameters:
name - the name of the event related to the script
filename - the file path of the script to execute
enabled - whether or not this script should be enabled

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Called as a result of implementing ActionListener

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - an object containing details of the event

focusGained

public void focusGained(java.awt.event.FocusEvent e)
Called as a result of implementing FocusListener

Specified by:
focusGained in interface java.awt.event.FocusListener
Parameters:
e - an object containing details of the event

focusLost

public void focusLost(java.awt.event.FocusEvent e)
Called as a result of implementing FocusListener

Specified by:
focusLost in interface java.awt.event.FocusListener
Parameters:
e - an object containing details of the event

loadSettings

public void loadSettings()
Loads the script dialog settings from the settings file


saveSettings

public void saveSettings()
Saves the script settings to the settings file


getFilenameForEvent

public java.lang.String getFilenameForEvent(java.lang.String eventName)
                                     throws EventNotFoundException
Returns the script file path associated with the specified event

Parameters:
eventName - the name of the event
Returns:
the filename associated with the event, or null if not found
Throws:
EventNotFoundException - if the specified event is not found

isEventEnabled

public boolean isEventEnabled(java.lang.String eventName)
                       throws EventNotFoundException
Returns whether or not the specified event is enabled

Parameters:
eventName - the name of the event
Returns:
whether of not the specified event is enabled.
Throws:
EventNotFoundException - if the specified event is not found

setVisible

public void setVisible(boolean b)
Overridden to disable the 'script details' related components

Overrides:
setVisible in class java.awt.Component

getTimedScriptDetails

public java.lang.Object[][] getTimedScriptDetails()
Returns the details of all the interval based or specific time based scripts

Returns:
a 2d array of objects containing the details of the scripts