com.enderak.procol.client.gui
Class ProColClientDockable

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--com.enderak.procol.client.gui.ProColClientDockable
All Implemented Interfaces:
javax.accessibility.Accessible, org.gjt.sp.jedit.EBComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ProColClientDockable
extends javax.swing.JPanel
implements org.gjt.sp.jedit.EBComponent

Main ProCol user interface class. Responsible for setting up plugin interface, handling EBMessages, and displaying error and informational messages.

Author:
Justin Dieters
See Also:
Serialized Form

Field Summary
static ProColPanel proColPanel
          The panel that contains the graphical interface items
 
Fields inherited from class javax.swing.JComponent
accessibleContext, 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
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
ProColClientDockable(org.gjt.sp.jedit.View view, java.lang.String position)
          Constructor for the ProCol object, called by jEdit using the command definition in dockables.xml
 
Method Summary
 void addNotify()
          Adds this dockable to the EditBus notification list

Also adds the ProColPanel to the ProColClient Observers list.
static void displayError(java.lang.String titleIn, java.lang.String errorIn)
          Displays an error message box
static void displayInfo(java.lang.String titleIn, java.lang.String messageIn)
          Displays an informational message box
 void handleMessage(org.gjt.sp.jedit.EBMessage message)
          Handles EBMessages (EditBus Messages) from jEdit
 void openProject(java.lang.String projectName)
           
 void removeNotify()
          Removes this dockable from the EditBus notification list

Also removes the ProColPanel from the ProColClient Observers list.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

proColPanel

public static ProColPanel proColPanel
The panel that contains the graphical interface items

Constructor Detail

ProColClientDockable

public ProColClientDockable(org.gjt.sp.jedit.View view,
                            java.lang.String position)
Constructor for the ProCol object, called by jEdit using the command definition in dockables.xml

Parameters:
view - Automatically passed by jEdit when dockable plugin window is created
position - Automatically passed by jEdit when dockable plugin window is created; this contains the docking position of this panel. This is used by this class to determine whether to set up interface with a horizonal or vertical layout.
Method Detail

displayError

public static void displayError(java.lang.String titleIn,
                                java.lang.String errorIn)
Displays an error message box

Parameters:
titleIn - Title of error box
errorIn - Error message to display

displayInfo

public static void displayInfo(java.lang.String titleIn,
                               java.lang.String messageIn)
Displays an informational message box

Parameters:
titleIn - Title of message box
messageIn - Informational message to display

addNotify

public void addNotify()
Adds this dockable to the EditBus notification list

Also adds the ProColPanel to the ProColClient Observers list. This is required because jEdit recreates the plugin's panel whenver it is reloaded or the Docking posistion changes.

Overrides:
addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()
Removes this dockable from the EditBus notification list

Also removes the ProColPanel from the ProColClient Observers list. This is required because jEdit recreates the plugin's panel whenver it is reloaded or the Docking posistion changes.

Overrides:
removeNotify in class javax.swing.JComponent

handleMessage

public void handleMessage(org.gjt.sp.jedit.EBMessage message)
Handles EBMessages (EditBus Messages) from jEdit

Specified by:
handleMessage in interface org.gjt.sp.jedit.EBComponent
Parameters:
message - Message from jEdit's EditBus to handle

openProject

public void openProject(java.lang.String projectName)
Parameters:
projectName - Sets the project name in the ProCol window