org.fife.ui.rtextfilechooser
Class RTextFileChooserOptionPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.fife.ui.OptionsDialogPanel
                      org.fife.ui.rtextfilechooser.RTextFileChooserOptionPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, ModifiableTableListener

public class RTextFileChooserOptionPanel
extends OptionsDialogPanel
implements java.awt.event.ActionListener, ModifiableTableListener

Option panel for configuring an RTextFileChooser. Your subclass of OptionsDialog should call this class's initialize(org.fife.ui.rtextfilechooser.RTextFileChooser) method in the dialog's initialize method, and this class's configureFileChooser(org.fife.ui.rtextfilechooser.RTextFileChooser) method in the dialog's doApplyImpl method.

Version:

0.3

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	AUTO_COMPLETE_PROPERTY
static java.lang.String	COLOR_CHANGED_PROPERTY
static java.lang.String	HIDDEN_FILES_PROPERTY
static java.lang.String	OFFER_SUGGESTIONS_PROPERTY
static java.lang.String	OPEN_FILES_STYLE_PROPERTY
static java.lang.String	STYLE_OPEN_FILES_PROPERTY

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

RTextFileChooserOptionPanel()
Constructor.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Listens for actions on this panel.
void	configureFileChooser(RTextFileChooser chooser) Configures the passed-in file chooser to have its parameters set like those specified in this option panel.
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.
javax.swing.JComponent	getTopJComponent() Returns the JComponent at the "top" of this Options panel.
void	initialize(RTextFileChooser chooser) Initializes the values displayed in this option panel.
void	modifiableTableChanged(ModifiableTableChangeEvent e) Called whenever the extension/color mapping table is changed.
protected void	setValuesImpl(java.awt.Frame owner) Sets the values displayed by this panel to reflect those in the application.

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

AUTO_COMPLETE_PROPERTY

public static final java.lang.String AUTO_COMPLETE_PROPERTY

See Also:

Constant Field Values

COLOR_CHANGED_PROPERTY

public static final java.lang.String COLOR_CHANGED_PROPERTY

See Also:

Constant Field Values

HIDDEN_FILES_PROPERTY

public static final java.lang.String HIDDEN_FILES_PROPERTY

See Also:

Constant Field Values

OFFER_SUGGESTIONS_PROPERTY

public static final java.lang.String OFFER_SUGGESTIONS_PROPERTY

See Also:

Constant Field Values

OPEN_FILES_STYLE_PROPERTY

public static final java.lang.String OPEN_FILES_STYLE_PROPERTY

See Also:

Constant Field Values

STYLE_OPEN_FILES_PROPERTY

public static final java.lang.String STYLE_OPEN_FILES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

RTextFileChooserOptionPanel

public RTextFileChooserOptionPanel()

Constructor. All strings in the file chooser are initialized via the current locale.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Listens for actions on this panel.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - The action that occurred.

configureFileChooser

public void configureFileChooser(RTextFileChooser chooser)

Configures the passed-in file chooser to have its parameters set like those specified in this option panel.

Parameters:

chooser - The file chooser to configure.

See Also:

initialize(org.fife.ui.rtextfilechooser.RTextFileChooser)

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. This application should implement FileChooserOwner.

Throws:

java.lang.IllegalArgumentException - If owner is not a FileChooserOwner.

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.

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

Returns:

The top JComponent.

initialize

public void initialize(RTextFileChooser chooser)

Initializes the values displayed in this option panel.

Parameters:

chooser - The file chooser whose properties you want to use to initialize this options panel.

See Also:

configureFileChooser(org.fife.ui.rtextfilechooser.RTextFileChooser)

modifiableTableChanged

public void modifiableTableChanged(ModifiableTableChangeEvent e)

Called whenever the extension/color mapping table is changed.

Specified by:

modifiableTableChanged in interface ModifiableTableListener

Parameters:

e - An event describing the change.

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. This should implement FileChooserOwner.

Throws:

java.lang.IllegalArgumentException - If owner is not a FileChooserOwner.

See Also:

OptionsDialogPanel.setValues(Frame)