org.fife.ui.rtextarea
Class RTextAreaOptionPanel

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.RTextAreaOptionPanel
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.DocumentListener

public class RTextAreaOptionPanel
extends OptionsDialogPanel
implements java.awt.event.ActionListener, javax.swing.event.DocumentListener, java.beans.PropertyChangeListener

Options panel for basic RTextArea options.

Version:
0.7
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
static java.lang.String ID
          ID used to identify this option panel.
 
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
RTextAreaOptionPanel()
          Constructor.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Listens for actions in this panel.
 void changedUpdate(javax.swing.event.DocumentEvent e)
          This doesn't get called but is here because this class implements DocumentListener.
protected  void doApplyImpl(java.awt.Frame owner)
          Applies the settings entered into this dialog on the specified application.
protected  OptionsDialogPanel.OptionsPanelCheckResult ensureValidInputsImpl()
          Checks whether or not all input the user specified on this panel is valid.
 java.awt.Color getBracketMatchBGColor()
          Returns the color the user chose for the background of a matched bracket.
 java.awt.Color getCurrentLineHighlightColor()
          Returns the current line highlight color chosen by the user.
 boolean getEmulateTabs()
          Returns whether or not the user decided to emulate tabs.
 boolean getHyperlinksEnabled()
          Returns whether the user decided to enable hyperlinks in editors.
 java.awt.Color getMarginLineColor()
          Returns the color the user chose for the margin line.
 int getMarginLinePosition()
          Returns the margin line position text on this panel.
 int getTabSize()
          Returns the tab size selected by the user.
 javax.swing.JComponent getTopJComponent()
          Returns the JComponent at the "top" of this Options panel.
 boolean getWordWrap()
          Returns whether the user selected word wrap.
 void insertUpdate(javax.swing.event.DocumentEvent e)
          Called when a text field in this panel gets updated.
 boolean isBracketMatchCheckboxSelected()
          Returns whether or not the bracketMatch checkbox is selected
 boolean isCurrentLineHighlightCheckboxSelected()
          Returns whether or not the current line highlight color checkbox is selected.
 boolean isMarginLineEnabled()
          Returns whether or not the margin line stuff is enabled (i.e., whether or not the "Margin line" checkbox is checked).
 boolean isWhitespaceVisible()
          Returns whether the user decided whitespace should be visible.
 void propertyChange(java.beans.PropertyChangeEvent e)
          Called when a property changes in an object we're listening to.
 void removeUpdate(javax.swing.event.DocumentEvent e)
          Called when a text field in this panel gets updated.
 void setBracketMatchBGColor(java.awt.Color color)
          Sets the color to use for the background of a matched bracket.
 void setBracketMatchCheckboxSelected(boolean selected)
          Sets whether or not the bracket match color checkbox is selected.
 void setTabLinesEnabled(boolean enabled)
           
protected  void setValuesImpl(java.awt.Frame owner)
          Sets the values displayed by this panel to reflect those in the application.
 void setWhitespaceVisible(boolean visible)
          Sets whether the "Visible whitespace" checkbox is selected.
 
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
 

Field Detail

ID

public static final java.lang.String ID
ID used to identify this option panel.

See Also:
Constant Field Values
Constructor Detail

RTextAreaOptionPanel

public RTextAreaOptionPanel()
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

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)
This doesn't get called but is here because this class implements DocumentListener.

Specified by:
changedUpdate in interface javax.swing.event.DocumentListener

doApplyImpl

protected void doApplyImpl(java.awt.Frame owner)
Applies the settings entered into this dialog on the specified application.

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.

getBracketMatchBGColor

public java.awt.Color getBracketMatchBGColor()
Returns the color the user chose for the background of a matched bracket.

Returns:
The color the user chose.
See Also:
setBracketMatchBGColor(java.awt.Color)

getCurrentLineHighlightColor

public java.awt.Color getCurrentLineHighlightColor()
Returns the current line highlight color chosen by the user.

Returns:
The color.

getEmulateTabs

public boolean getEmulateTabs()
Returns whether or not the user decided to emulate tabs.

Returns:
true iff the "emulate tabs with whitespace" checkbox was checked.

getHyperlinksEnabled

public boolean getHyperlinksEnabled()
Returns whether the user decided to enable hyperlinks in editors.

Returns:
Whether the user wants hyperlinks enabled.

getMarginLineColor

public java.awt.Color getMarginLineColor()
Returns the color the user chose for the margin line.

Returns:
The color the user chose.

getMarginLinePosition

public int getMarginLinePosition()
Returns the margin line position text on this panel.

Returns:
The text in the "margin line position" text field.

getTabSize

public int getTabSize()
Returns the tab size selected by the user.

Returns:
The tab size selected by the user.

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

getWordWrap

public boolean getWordWrap()
Returns whether the user selected word wrap.

Returns:
Whether or not the word wrap checkbox is checked.

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)
Called when a text field in this panel gets updated.

Specified by:
insertUpdate in interface javax.swing.event.DocumentListener

isBracketMatchCheckboxSelected

public boolean isBracketMatchCheckboxSelected()
Returns whether or not the bracketMatch checkbox is selected

Returns:
Whether or not the checkbox is selected.
See Also:
setBracketMatchCheckboxSelected(boolean)

isCurrentLineHighlightCheckboxSelected

public boolean isCurrentLineHighlightCheckboxSelected()
Returns whether or not the current line highlight color checkbox is selected.

Returns:
Whether or not the checkbox is selected.

isMarginLineEnabled

public boolean isMarginLineEnabled()
Returns whether or not the margin line stuff is enabled (i.e., whether or not the "Margin line" checkbox is checked).

Returns:
Whether or not the margin line options are enabled.

isWhitespaceVisible

public boolean isWhitespaceVisible()
Returns whether the user decided whitespace should be visible.

Returns:
Whether or not the user wants whitespace to be visible in the text area(s).
See Also:
setWhitespaceVisible(boolean)

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

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)
Called when a text field in this panel gets updated.

Specified by:
removeUpdate in interface javax.swing.event.DocumentListener

setBracketMatchBGColor

public void setBracketMatchBGColor(java.awt.Color color)
Sets the color to use for the background of a matched bracket.

Parameters:
color - The color to use.
See Also:
getBracketMatchBGColor()

setBracketMatchCheckboxSelected

public void setBracketMatchCheckboxSelected(boolean selected)
Sets whether or not the bracket match color checkbox is selected.

Parameters:
selected - Whether or not the checkbox is selected.
See Also:
isBracketMatchCheckboxSelected()

setTabLinesEnabled

public void setTabLinesEnabled(boolean enabled)

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)

setWhitespaceVisible

public void setWhitespaceVisible(boolean visible)
Sets whether the "Visible whitespace" checkbox is selected.

Parameters:
visible - Whether the "visible whitespace" checkbox should be selected.
See Also:
isWhitespaceVisible()