org.fife.ui.rtextarea
Class CaretAndSelectionOptionPanel

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.fife.ui.OptionsDialogPanel
                      extended by org.fife.ui.rtextarea.CaretAndSelectionOptionPanel
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ChangeListener

public class CaretAndSelectionOptionPanel
extends OptionsDialogPanel
implements java.awt.event.ActionListener, javax.swing.event.ChangeListener, java.beans.PropertyChangeListener

Option panel for caret and selection options.

Version:
0.5
Author:
Robert Futrell
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.fife.ui.OptionsDialogPanel
OptionsDialogPanel.OptionPanelBorder, OptionsDialogPanel.OptionsPanelCheckResult
 
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.fife.ui.OptionsDialogPanel
hasUnsavedChanges
 
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
CaretAndSelectionOptionPanel()
          Constructor.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Listens for actions in this panel.
protected  void doApplyImpl(java.awt.Frame owner)
          Applies the settings entered into this panel on the specified application.
protected  OptionsDialogPanel.OptionsPanelCheckResult ensureValidInputsImpl()
          Checks whether or not all input the user specified on this panel is valid.
 int getBlinkRate()
          Returns the blink rate selected by the user.
 java.awt.Color getCaretColor()
          Returns the color the user chose for the caret.
 int getCaretStyle(int mode)
          Returns the caret style for either the insert or overwrite caret that the user chose.
 java.awt.Color getMarkAllHighlightColor()
          Returns the color selected by the user for "mark all."
 boolean getRoundedSelection()
          Returns whether the user selected to use rounded edges on selections.
 java.awt.Color getSelectionColor()
          Returns the color the user chose for selections.
 javax.swing.JComponent getTopJComponent()
          Returns the JComponent at the "top" of this Options panel.
 void propertyChange(java.beans.PropertyChangeEvent e)
          Called when a property changes in an object we're listening to.
protected  void setValuesImpl(java.awt.Frame owner)
          Sets the values displayed by this panel to reflect those in the application.
 void stateChanged(javax.swing.event.ChangeEvent e)
          Called when the user changes the caret blink rate spinner value.
 
Methods inherited from class org.fife.ui.OptionsDialogPanel
addChildPanel, addLeftAligned, addLeftAligned, addLeftAligned, createHorizontalBox, doApply, ensureValidInputs, getChildPanel, getChildPanelCount, getIcon, getId, getName, getOptionsDialog, getParentPanel, hasUnsavedChanges, setIcon, setId, setName, setUnsavedChanges, setValues, toString
 
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, 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, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CaretAndSelectionOptionPanel

public CaretAndSelectionOptionPanel()
Constructor.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Listens for actions in this panel.

Specified by:
actionPerformed in interface java.awt.event.ActionListener

doApplyImpl

protected void doApplyImpl(java.awt.Frame owner)
Applies the settings entered into this panel on the specified application. Child panels are not handled.

Specified by:
doApplyImpl in class OptionsDialogPanel
Parameters:
owner - The application.
See Also:
OptionsDialogPanel.doApply(Frame)

ensureValidInputsImpl

protected OptionsDialogPanel.OptionsPanelCheckResult ensureValidInputsImpl()
Checks whether or not all input the user specified on this panel is valid. This should be overridden to check, for example, whether text fields have valid values, etc. This method will be called whenever the user clicks "OK" or "Apply" on the options dialog to ensure all input is valid. If it isn't, the component with invalid data will be given focus and the user will be prompted to fix it.

Specified by:
ensureValidInputsImpl in class OptionsDialogPanel
Returns:
null if the panel has all valid inputs, or an OptionsPanelCheckResult if an input was invalid. This component is the one that had the error and will be given focus, and the string is an error message that will be displayed.

getBlinkRate

public int getBlinkRate()
Returns the blink rate selected by the user.

Returns:
The blink rate.

getCaretColor

public java.awt.Color getCaretColor()
Returns the color the user chose for the caret.

Returns:
The caret color the user chose.

getCaretStyle

public int getCaretStyle(int mode)
Returns the caret style for either the insert or overwrite caret that the user chose.

Parameters:
mode - Either RTextArea.INSERT_MODE or RTextArea.OVERWRITE_MODE.
Returns:
The style of that caret, such as ConfigurableCaret.VERTICAL_LINE_STYLE.
See Also:
ConfigurableCaret

getMarkAllHighlightColor

public java.awt.Color getMarkAllHighlightColor()
Returns the color selected by the user for "mark all."

Returns:
The color.

getRoundedSelection

public boolean getRoundedSelection()
Returns whether the user selected to use rounded edges on selections.

Returns:
Whether rounded selection edges were selected.

getSelectionColor

public java.awt.Color getSelectionColor()
Returns the color the user chose for selections.

Returns:
The selection color the user chose.

getTopJComponent

public javax.swing.JComponent getTopJComponent()
Returns the JComponent at the "top" of this Options panel. This is the component that will receive focus if the user switches to this Options panel in the Options dialog. As an added bonus, if this component is a JTextComponent, its text is selected for easy changing.

Specified by:
getTopJComponent in class OptionsDialogPanel

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)
Called when a property changes in an object we're listening to.

Specified by:
propertyChange in interface java.beans.PropertyChangeListener

setValuesImpl

protected void setValuesImpl(java.awt.Frame owner)
Sets the values displayed by this panel to reflect those in the application. Child panels are not handled.

Specified by:
setValuesImpl in class OptionsDialogPanel
Parameters:
owner - The parent application.
See Also:
OptionsDialogPanel.setValues(Frame)

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)
Called when the user changes the caret blink rate spinner value.

Specified by:
stateChanged in interface javax.swing.event.ChangeListener
Parameters:
e - The change event.