org.acm.seguin.ide.common.options
Class JSHelpOptionPane

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.acm.seguin.ide.common.options.JSHelpOptionPane
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
Direct Known Subclasses:
JSAlignmentOptionPane, JSCommentOptionPane, JSGeneralOptionPane, JSIndentOptionPane, JSJavadocOptionPane, JSSortOptionPane, JSSpacingOptionPane, JSStubs2OptionPane, JSStubsJUnitOptionPane, JSStubsOptionPane, JSTagsOptionPane, NavigatorOptionPane, PMDOptionPane

public abstract class JSHelpOptionPane
extends javax.swing.JPanel

Since:
1.0
Version:
$Version: $
Author:
Mike Atkinson ( Mike@ladyshot.demon.co.uk ), Dirk Moebius (dmoebius@gmx.net )
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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
protected  java.awt.GridBagLayout gridBag
          The layout manager.
protected  boolean initialized
          Has the option pane been initialized?
static java.lang.String[] NAMES
           
protected  PropertiesFile props
          Description of the Field
protected  int y
          The number of components already added to the layout manager.
 
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
JSHelpOptionPane(java.lang.String key, java.lang.String type, java.lang.String project)
          Constructor for the JSHelpOptionPane object
 
Method Summary
 void _init()
          This method should create and arrange the components of the option pane and initialize the option data displayed to the user.
 void _save()
          Called when the options dialog's "ok" button is clicked.
 void addComponent(java.awt.Component comp)
          Adds a component to the option pane.
 void addComponent(java.awt.Component comp1, java.awt.Component comp2)
          Adds a labeled component to the option pane.
 void addComponent(java.awt.Component comp1, java.awt.Component comp2, int fill)
          Adds a labeled component to the option pane.
 void addComponent(java.awt.Component comp, int fill)
          Adds a component to the option pane.
 void addComponent(java.lang.String label, java.awt.Component comp)
          Adds a labeled component to the option pane.
 void addComponent(java.lang.String label, java.awt.Component comp, int fill)
          Adds a labeled component to the option pane.
protected  SelectedPanel addComponent(java.lang.String option, java.lang.String label, javax.swing.JComponent component)
          Adds a feature to the Component attribute of the JSHelpOptionPane object
protected  SelectedPanel addComponent(java.lang.String option, java.lang.String defaultOption, java.lang.String label, javax.swing.JComponent component)
          Adds a feature to the Component attribute of the JSHelpOptionPane object
protected  void addHelpArea()
          Adds a feature to the HelpArea attribute of the JSHelpOptionPane object
protected  void addHelpFor(java.awt.Component comp, java.lang.String compProperty)
          Adds a feature to the HelpFor attribute of the JSHelpOptionPane object
 void addSeparator()
          Adds a separator component.
 void addSeparator(java.lang.String label)
          Adds a separator component.
 java.awt.Component getComponent()
          Returns the component that should be displayed for this option pane.
static java.lang.String getIdeJavaStyleOption(java.lang.String prop)
          Gets the IDE Property attribute of the JSHelpOptionPane class
static java.lang.String getIdeProperty(java.lang.String prop)
          Gets the IDE Property attribute of the JSHelpOptionPane class
 java.lang.String getName()
          Returns the internal name of this option pane.
 void init()
          Do not override this method, override _init() instead.
 void save()
          Do not override this method, override _save() instead.
 void setHelpText(java.lang.String text)
           
 
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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAMES

public static final java.lang.String[] NAMES

props

protected PropertiesFile props
Description of the Field


initialized

protected boolean initialized
Has the option pane been initialized?


gridBag

protected java.awt.GridBagLayout gridBag
The layout manager.


y

protected int y
The number of components already added to the layout manager.

Constructor Detail

JSHelpOptionPane

public JSHelpOptionPane(java.lang.String key,
                        java.lang.String type,
                        java.lang.String project)
Constructor for the JSHelpOptionPane object

Parameters:
key - Description of the Parameter
project - Description of the Parameter
Method Detail

getIdeProperty

public static java.lang.String getIdeProperty(java.lang.String prop)
Gets the IDE Property attribute of the JSHelpOptionPane class

Parameters:
prop - Description of the Parameter
Returns:
The IDE Property value

getIdeJavaStyleOption

public static java.lang.String getIdeJavaStyleOption(java.lang.String prop)
Gets the IDE Property attribute of the JSHelpOptionPane class

Parameters:
prop - Description of the Parameter
Returns:
The IDE Property value

addHelpFor

protected void addHelpFor(java.awt.Component comp,
                          java.lang.String compProperty)
Adds a feature to the HelpFor attribute of the JSHelpOptionPane object

Parameters:
comp - The feature to be added to the HelpFor attribute
compProperty - The feature to be added to the HelpFor attribute

addHelpArea

protected void addHelpArea()
Adds a feature to the HelpArea attribute of the JSHelpOptionPane object


addComponent

protected SelectedPanel addComponent(java.lang.String option,
                                     java.lang.String label,
                                     javax.swing.JComponent component)
Adds a feature to the Component attribute of the JSHelpOptionPane object

Parameters:
option - The feature to be added to the Component attribute
label - The feature to be added to the Component attribute
component - The feature to be added to the Component attribute
Returns:
Description of the Return Value

addComponent

protected SelectedPanel addComponent(java.lang.String option,
                                     java.lang.String defaultOption,
                                     java.lang.String label,
                                     javax.swing.JComponent component)
Adds a feature to the Component attribute of the JSHelpOptionPane object

Parameters:
option - The feature to be added to the Component attribute
defaultOption - The feature to be added to the Component attribute
label - The feature to be added to the Component attribute
component - The feature to be added to the Component attribute
Returns:
Description of the Return Value

setHelpText

public void setHelpText(java.lang.String text)

getName

public java.lang.String getName()
Returns the internal name of this option pane. The option pane's label is set to the value of the property named options.name.label.

Overrides:
getName in class java.awt.Component

getComponent

public java.awt.Component getComponent()
Returns the component that should be displayed for this option pane. Because this class extends Component, it simply returns "this".


init

public void init()
Do not override this method, override _init() instead.


save

public void save()
Do not override this method, override _save() instead.


addComponent

public void addComponent(java.lang.String label,
                         java.awt.Component comp)
Adds a labeled component to the option pane. Components are added in a vertical fashion, one per row. The label is displayed to the left of the component.

Parameters:
label - The label
comp - The component

addComponent

public void addComponent(java.lang.String label,
                         java.awt.Component comp,
                         int fill)
Adds a labeled component to the option pane. Components are added in a vertical fashion, one per row. The label is displayed to the left of the component.

Parameters:
label - The label
comp - The component
fill - Fill parameter to GridBagConstraints for the right component

addComponent

public void addComponent(java.awt.Component comp1,
                         java.awt.Component comp2)
Adds a labeled component to the option pane. Components are added in a vertical fashion, one per row. The label is displayed to the left of the component.

Parameters:
comp1 - The label
comp2 - The component
Since:
JRefactory 2.8.02

addComponent

public void addComponent(java.awt.Component comp1,
                         java.awt.Component comp2,
                         int fill)
Adds a labeled component to the option pane. Components are added in a vertical fashion, one per row. The label is displayed to the left of the component.

Parameters:
comp1 - The label
comp2 - The component
fill - Fill parameter to GridBagConstraints for the right component
Since:
JRefactory 2.8.02

addComponent

public void addComponent(java.awt.Component comp)
Adds a component to the option pane. Components are added in a vertical fashion, one per row.

Parameters:
comp - The component

addComponent

public void addComponent(java.awt.Component comp,
                         int fill)
Adds a component to the option pane. Components are added in a vertical fashion, one per row.

Parameters:
comp - The component
fill - Fill parameter to GridBagConstraints
Since:
JRefactory 2.8.02

addSeparator

public void addSeparator()
Adds a separator component.

Parameters:
label - The separator label property
Since:
JRefactory 2.8.02

addSeparator

public void addSeparator(java.lang.String label)
Adds a separator component.

Parameters:
label - The separator label property
Since:
JRefactory 2.8.02

_init

public void _init()
This method should create and arrange the components of the option pane and initialize the option data displayed to the user. This method is called when the option pane is first displayed, and is not called again for the lifetime of the object.


_save

public void _save()
Called when the options dialog's "ok" button is clicked. This should save any properties being edited in this option pane.