VdexReload 1.1.3 API

uk.ac.reload.dweezil.gui.widgets
Class ReloadFileTextField

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byuk.ac.reload.dweezil.gui.widgets.ReloadFileTextField
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, ReloadWidget, java.io.Serializable

public class ReloadFileTextField
extends javax.swing.JPanel
implements ReloadWidget

A Combination of JTextField and File Chooser for selecting files

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
protected  javax.swing.JButton _button
          A button to open the File Chooser
protected  ReloadFileChooser _chooser
          The chooser
protected  int _maxLength
          The maximum number of characters allowed
protected  java.io.File _relativePath
          Whether the file path should be relative or absolute
protected  java.lang.String _text
          The text to display
protected  javax.swing.JTextField _textField
          A Textfield to display the value
protected  int _type
          Type of chooser - file or folder
static int FILE_TYPE
          Type of chooser - FILE_TYPE
static int FOLDER_TYPE
          Type of chooser - FOLDER_TYPE
 
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
ReloadFileTextField(int type, java.lang.String text, javax.swing.Icon icon)
          Constructor
 
Method Summary
 void addDocumentListener(javax.swing.event.DocumentListener dl)
          Add a DocumentListener to the Text Box
 java.io.File getRelativePath()
          Get the relative file path
 javax.swing.JTextField getTextField()
          Get the Text Field
 java.lang.String getTextValue()
          Get the Value from the text field
 void insertTextValue(java.lang.String text)
          Insert some text into the text field
 boolean isSingleLine()
          Determine whether this widget only needs a single line to display itself
 void removeDocumentListener(javax.swing.event.DocumentListener dl)
          Remove a DocumentListener from the Text Box
 void setEnabled(boolean enabled)
          Set the components enabled/disabled
 void setMaxLength(int maxLength)
          Set the maximum allowed number of characters
 void setRelativePath(java.io.File relativePath)
          Set the relative file path.
 void setTextValue(java.lang.String value)
          Set the Value in the Text Field
protected  void setupAction()
          Set up the chooser button action
 
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, 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, isEnabled, 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
 

Field Detail

_maxLength

protected int _maxLength
The maximum number of characters allowed


_textField

protected javax.swing.JTextField _textField
A Textfield to display the value


_button

protected javax.swing.JButton _button
A button to open the File Chooser


_chooser

protected ReloadFileChooser _chooser
The chooser


_text

protected java.lang.String _text
The text to display


_type

protected int _type
Type of chooser - file or folder


_relativePath

protected java.io.File _relativePath
Whether the file path should be relative or absolute


FILE_TYPE

public static int FILE_TYPE
Type of chooser - FILE_TYPE


FOLDER_TYPE

public static int FOLDER_TYPE
Type of chooser - FOLDER_TYPE

Constructor Detail

ReloadFileTextField

public ReloadFileTextField(int type,
                           java.lang.String text,
                           javax.swing.Icon icon)
Constructor

Parameters:
type - the type of choose file/folder
text - the choose dialog title
icon - the open button icon
Method Detail

setupAction

protected void setupAction()
Set up the chooser button action


getTextField

public javax.swing.JTextField getTextField()
Get the Text Field

Returns:
the TextField

setTextValue

public void setTextValue(java.lang.String value)
Set the Value in the Text Field

Specified by:
setTextValue in interface ReloadWidget
Parameters:
value - the value to be set in the text field

insertTextValue

public void insertTextValue(java.lang.String text)
Insert some text into the text field

Specified by:
insertTextValue in interface ReloadWidget
Parameters:
text - the text to be inserted into the text field

getTextValue

public java.lang.String getTextValue()
Get the Value from the text field

Specified by:
getTextValue in interface ReloadWidget
Returns:
the text in the text field

setMaxLength

public void setMaxLength(int maxLength)
Set the maximum allowed number of characters

Specified by:
setMaxLength in interface ReloadWidget
Parameters:
maxLength - allowed number of characters

isSingleLine

public boolean isSingleLine()
Determine whether this widget only needs a single line to display itself

Specified by:
isSingleLine in interface ReloadWidget
Returns:
true if this widget needs only a single line to display itself, false otherwise

getRelativePath

public java.io.File getRelativePath()
Get the relative file path

Returns:
the relative file path or null

setRelativePath

public void setRelativePath(java.io.File relativePath)
Set the relative file path. If null, it will not be relative

Parameters:
relativePath - the relative file path

addDocumentListener

public void addDocumentListener(javax.swing.event.DocumentListener dl)
Add a DocumentListener to the Text Box

Specified by:
addDocumentListener in interface ReloadWidget
Parameters:
dl - the DocumentListener to add

removeDocumentListener

public void removeDocumentListener(javax.swing.event.DocumentListener dl)
Remove a DocumentListener from the Text Box

Specified by:
removeDocumentListener in interface ReloadWidget
Parameters:
dl - the DocumentListener to remove

setEnabled

public void setEnabled(boolean enabled)
Set the components enabled/disabled

Parameters:
enabled - if true enables the component, and if false disables the component

VdexReload 1.1.3 API