sidekick
Class ModeOptionsPane

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.gjt.sp.jedit.AbstractOptionPane
                      extended by sidekick.ModeOptionsPane
All Implemented Interfaces:
java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, org.gjt.sp.jedit.OptionPane
Direct Known Subclasses:
SideKickModeOptionsPane

public abstract class ModeOptionsPane
extends org.gjt.sp.jedit.AbstractOptionPane
implements java.awt.event.ItemListener

A specialized OptionPane which has mode-overridable properties. Includes convenience methods for getting and setting mode properties, as well as global defaults. To define an option pane which gets added to the ModeOptionsDialog of SideKick, you can define a service like this:

        <SERVICE CLASS="org.gjt.sp.jedit.options.ModeOptionPane" NAME="sidekick">
                new sidekick.SideKickModeOptionsPane();
        </SERVICE>
 

Since:
SideKick 0.7.1
Author:
Alan Ezust alan@jedit.org
See Also:
Serialized Form

Nested Class Summary
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.gjt.sp.jedit.AbstractOptionPane
gridBag, initialized, y
 
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
protected ModeOptionsPane(java.lang.String name)
           
 
Method Summary
protected abstract  void _load()
          Override this method.
protected abstract  void _reset()
          Un-sets all mode properties, so that the global defaults will be used instead.
 void clearModeProperty(java.lang.String key)
           
 boolean getBooleanProperty(java.lang.String key)
           
static boolean getBooleanProperty(java.lang.String mode, java.lang.String key)
           
 int getIntegerProperty(java.lang.String key, int def)
           
static int getIntegerProperty(java.lang.String mode, java.lang.String key, int def)
           
protected  java.lang.String getMode()
           
 java.lang.String getProperty(java.lang.String key)
           
static java.lang.String getProperty(java.lang.String mode, java.lang.String key)
           
 void itemStateChanged(java.awt.event.ItemEvent e)
           
 void load()
          Load mode properties into input components, using global props if mode props are not set.
static java.lang.String modePrefix(java.lang.String mode, java.lang.String key)
           
 void setBooleanProperty(java.lang.String key, boolean val)
           
 void setIntegerProperty(java.lang.String key, int value)
           
static void setIntegerProperty(java.lang.String mode, java.lang.String key, int value)
           
 void setProperty(java.lang.String key, java.lang.String value)
           
static void setProperty(java.lang.String mode, java.lang.String key, java.lang.String value)
           
 
Methods inherited from class org.gjt.sp.jedit.AbstractOptionPane
_init, _save, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addSeparator, addSeparator, getComponent, getName, init, newLabel, save
 
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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModeOptionsPane

protected ModeOptionsPane(java.lang.String name)
Method Detail

setIntegerProperty

public static void setIntegerProperty(java.lang.String mode,
                                      java.lang.String key,
                                      int value)

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String mode,
                                         java.lang.String key)

getIntegerProperty

public static int getIntegerProperty(java.lang.String mode,
                                     java.lang.String key,
                                     int def)

setProperty

public static void setProperty(java.lang.String mode,
                               java.lang.String key,
                               java.lang.String value)

getProperty

public static java.lang.String getProperty(java.lang.String mode,
                                           java.lang.String key)

modePrefix

public static java.lang.String modePrefix(java.lang.String mode,
                                          java.lang.String key)

load

public final void load()
Load mode properties into input components, using global props if mode props are not set.


_load

protected abstract void _load()
Override this method. Called by @ref load().


_reset

protected abstract void _reset()
Un-sets all mode properties, so that the global defaults will be used instead.


getMode

protected java.lang.String getMode()

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)
Specified by:
itemStateChanged in interface java.awt.event.ItemListener

getProperty

public java.lang.String getProperty(java.lang.String key)
Parameters:
key - a the property name.
Returns:
a mode-specific property, depending on what mode is selected in the combo box of the SideKickProperties dialog.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String key)

getIntegerProperty

public int getIntegerProperty(java.lang.String key,
                              int def)

setBooleanProperty

public void setBooleanProperty(java.lang.String key,
                               boolean val)

clearModeProperty

public void clearModeProperty(java.lang.String key)

setIntegerProperty

public void setIntegerProperty(java.lang.String key,
                               int value)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)