qflib 0.99

de.qfs.lib.option
Class FileOptionEdit

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byde.qfs.lib.option.OptionEdit
                      extended byde.qfs.lib.option.SimpleOptionEdit
                          extended byde.qfs.lib.option.SelectorOptionEdit
                              extended byde.qfs.lib.option.FileOptionEdit
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.event.MouseListener, java.io.Serializable

public class FileOptionEdit
extends SelectorOptionEdit

An OptionEdit for a FileOption. It can also be used in combination with a StringOption by setting the resource option.name.edit.class to the value de.qfs.lib.option.FileOptionEdit. It uses the following resources:

Resource name Usage
option.name.label The label for the Option (optional, default empty).
option.name.mnemonic Keyboard accelerator (optional, default none).
option.name.disabled If true, the edit will be disabled and remain so even if setEnabled(true) is called (optional, default false).
option.name.select Whether to select the whole text when the edit gains focus (optional, default false).
option.name.action The type of operation for the file dialog. Values are "open" or "save" for a standard open or save dialog. Any other value is used as the text of the approve button (optional, default "open").
option.name.title The title of the file dialog (optional, default is Swing dependent).
option.name.numfilters The number of file filters for the dialog (optional, default none).
option.name.filter<n>.extensions The extensions for the n-th file filter, starting from 1. Extensions must include the '.' character. Multiple extensions are separated by whitespace.
option.name.filter<n>.desc The description for the n-th file filter, starting from 1.
option.allfilter Whether to add the all-files file filter to the file dialog (optional, default true if no other filters are defined, false otherwise).
option.askoverwrite Whether to ask for permission to overwrite a file that already exists (optional, default true if type is "save", false otherwise).

Since:
0.99.0
Author:
Gregor Schmid
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class de.qfs.lib.option.SelectorOptionEdit
select
 
Fields inherited from class de.qfs.lib.option.SimpleOptionEdit
canFocus, label, selectOnFocus, text
 
Fields inherited from class de.qfs.lib.option.OptionEdit
disabled, group, option
 
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
FileOptionEdit()
          Create a new FileOptionEdit.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Notify the edit that the button was pressed.
 boolean checkValue()
          Check the currently entered value of the OptionEdit.
 void init()
          Initialize the edit.
 void readValue()
          Read the currently entered value and store it in the Option.
protected  java.io.File showFileDialog(java.lang.String current)
          Ask the user for the file to load or save to.
 
Methods inherited from class de.qfs.lib.option.SelectorOptionEdit
createButton, setEnabled
 
Methods inherited from class de.qfs.lib.option.SimpleOptionEdit
focusGained, focusLost, getText, isEnabled, isModified, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, requestFocus, setText, update
 
Methods inherited from class de.qfs.lib.option.OptionEdit
addPackage, getBoolean, getInt, getOption, getOptionGroup, getString, getWeight, isDisabled, makeEdit, setDisabled, setOptionGroup, update
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FileOptionEdit

public FileOptionEdit()
Create a new FileOptionEdit.

Method Detail

init

public void init()
Initialize the edit.

Overrides:
init in class SelectorOptionEdit

checkValue

public boolean checkValue()
Check the currently entered value of the OptionEdit. If the value is not valid, request the focus.

Overrides:
checkValue in class SimpleOptionEdit
Returns:
True if the value is valid, false otherwise.

readValue

public void readValue()
Read the currently entered value and store it in the Option.

Overrides:
readValue in class SimpleOptionEdit

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Notify the edit that the button was pressed.

Parameters:
e - Ignored.

showFileDialog

protected java.io.File showFileDialog(java.lang.String current)
Ask the user for the file to load or save to.

Parameters:
current - The current file or null.
Returns:
The new file.

qflib 0.99