public class AbstractOptionPane extends javax.swing.JPanel implements OptionPane
See EditPlugin
for information on how jEdit obtains and constructs
option pane instances.
Most option panes extend this implementation of OptionPane
, instead
of implementing OptionPane
directly. This class provides a convenient
default framework for laying out configuration options.
It is derived from Java's JPanel
class and uses a
GridBagLayout
object for component management. Since
GridBagLayout
can be a bit cumbersome to use, this class
contains shortcut methods to simplify layout:
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected java.awt.GridBagLayout |
gridBag
The layout manager.
|
protected boolean |
initialized
Has the option pane been initialized?
|
protected int |
y
The number of components already added to the layout manager.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
AbstractOptionPane(java.lang.String internalName)
Creates a new option pane.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_init()
This method should create and arrange the components of the option pane
and initialize the option data displayed to the user.
|
protected 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.
|
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.
|
java.lang.String |
getName()
Returns the internal name of this option pane.
|
void |
init()
This method is called every time the option pane is displayed.
|
javax.swing.JLabel |
newLabel(java.lang.String label,
java.awt.Component comp) |
void |
save()
Called when the options dialog's "ok" button is clicked.
|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, hide, 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
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
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, 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
protected boolean initialized
protected java.awt.GridBagLayout gridBag
protected int y
public AbstractOptionPane(java.lang.String internalName)
internalName
- The internal name.
This should be the same name as that provided
in the plugin's plugin.className.option-group
or .option-pane
property.
The option pane's label is set to the
value of the property named options.name.label
.public java.lang.String getName()
options.name.label
.getName
in interface OptionPane
getName
in class java.awt.Component
options.name.label
.jEdit.getProperty(String)
public java.awt.Component getComponent()
getComponent
in interface OptionPane
public final void init()
OptionPane
init
in interface OptionPane
public final void save()
OptionPane
save
in interface OptionPane
public javax.swing.JLabel newLabel(java.lang.String label, java.awt.Component comp)
label
- The label to associate with compcomp
- The component to associate the labelpublic void addComponent(java.lang.String label, java.awt.Component comp)
label
- The labelcomp
- The componentpublic void addComponent(java.lang.String label, java.awt.Component comp, int fill)
label
- The labelcomp
- The componentfill
- Fill parameter to GridBagConstraints for the right
componentpublic void addComponent(java.awt.Component comp1, java.awt.Component comp2)
comp1
- The labelcomp2
- The componentpublic void addComponent(java.awt.Component comp1, java.awt.Component comp2, int fill)
comp1
- The labelcomp2
- The componentfill
- Fill parameter to GridBagConstraints for the right
componentpublic void addComponent(java.awt.Component comp)
comp
- The componentpublic void addComponent(java.awt.Component comp, int fill)
comp
- The componentfill
- Fill parameter to GridBagConstraintspublic void addSeparator()
public void addSeparator(java.lang.String label)
label
- The separator label propertyprotected void _init()
protected void _save()