projectviewer.gui

Class OptionPaneBase

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gjt.sp.jedit.AbstractOptionPane

projectviewer.gui.OptionPaneBase

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, org.gjt.sp.jedit.OptionPane

Direct Known Subclasses:

ExtensionConfigPane, ProjectAppConfigPane, ProjectFilterPane, ProjectViewerOptionsPane

public abstract class OptionPaneBase
extends org.gjt.sp.jedit.AbstractOptionPane

A base class for option panes that makes some common tasks easier.

Since:

PV 3.0.0

Author:

Marcelo Vanzin

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

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

Constructors

Constructor and Description
OptionPaneBase(java.lang.String name, java.lang.String propRoot) Creates a new option pane.

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.swing.JCheckBox	addCheckBox(java.lang.String label, boolean selected) Shortcut for adding a checkbox with an optional tooltip.
protected void	addComponent(javax.swing.JComponent comp, java.lang.String labelProp) Adds a component adding an optional label, and setting its tooltip if one is available.
protected void	addComponent(javax.swing.JComponent comp, java.lang.String labelProp, int fill) Adds a component adding an optional label, and setting its tooltip if one is available, using the given fill property.
void	addSeparator(java.lang.String prop) Creates a separator with the given text.
protected javax.swing.JLabel	createLabel(java.lang.String prop) Creates a label based on the given property name.
protected java.lang.String	prop(java.lang.String property) Shortcut for retrieving jEdit properties, avoiding ridiculously long lines.

Methods inherited from class org.gjt.sp.jedit.AbstractOptionPane

_init, _save, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, 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, 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, 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, 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

Constructor Detail

OptionPaneBase

public OptionPaneBase(java.lang.String name,
              java.lang.String propRoot)

Creates a new option pane.

Parameters:

name - Name of the pane.

propRoot - Root of properties retrieved with prop(String).

Method Detail

addComponent

protected void addComponent(javax.swing.JComponent comp,
                java.lang.String labelProp)

Adds a component adding an optional label, and setting its tooltip if one is available. Component is added with the fill property set to GridBagConstraints.HORIZONTAL.

Parameters:

comp - Component to add.

labelProp - Label property name. Tooltip is the same property, with ".tooltip" added.

addComponent

protected void addComponent(javax.swing.JComponent comp,
                java.lang.String labelProp,
                int fill)

Adds a component adding an optional label, and setting its tooltip if one is available, using the given fill property.

Parameters:

comp - Component to add.

labelProp - Label property name. Tooltip is the same property, with ".tooltip" added.

fill - GridBagConstraints fill property.

addCheckBox

protected javax.swing.JCheckBox addCheckBox(java.lang.String label,
                                boolean selected)

Shortcut for adding a checkbox with an optional tooltip.

Parameters:

label - Property name for the label / tooltip.

selected - Whether the checkbox is checked.

Returns:

The checkbox (already added to the UI).

createLabel

protected javax.swing.JLabel createLabel(java.lang.String prop)

Creates a label based on the given property name.

Parameters:

prop - Property name for the text / tooltip.

Returns:

A new JLabel.

addSeparator

public void addSeparator(java.lang.String prop)

Creates a separator with the given text.

Overrides:

addSeparator in class org.gjt.sp.jedit.AbstractOptionPane

Parameters:

prop - Property name for the text.

Since:

3.4.3

prop

protected java.lang.String prop(java.lang.String property)

Shortcut for retrieving jEdit properties, avoiding ridiculously long lines.

Parameters:

property - Property name.

Returns:

Property value (may be null).