VdexReload 1.1.3 API

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

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.ReloadButtonTextArea
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, ReloadWidget, java.io.Serializable

public class ReloadButtonTextArea
extends javax.swing.JPanel
implements ReloadWidget

A Combination of JTextArea and JButton. This is used for providing Vdex Browsing facility from the Metadata Editor.

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 for browing Vdex vocabulary values
protected  int _maxLength
          The maximum number of characters allowed
protected  ReloadSchemaDocument _reloadSchemaDocument
          The Reload Schema Document
protected  ReloadSchemaElement _schemaElement
          The Reload Schema Element bound to the JTextPane
protected  java.lang.String _text
          The text to display on button
protected  javax.swing.JTextArea _textArea
          A JTextArea to display the value
protected  int _type
          The button type
protected  java.lang.String _vdexSourcePath
          The Vdex Source Path, that is the source element that has the Vocabulary Name or Identifier of the Vdex file that we have to use for browsing
protected  java.lang.String _vdexSourceValue
          The Vdex Source Value, that is the Vocabulary Name or Identifier of the Vdex file that we will use for browsing
static int VDEX_BROWSE_TYPE
          Type of button - BROWSE_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
ReloadButtonTextArea(ReloadSchemaDocument reloadSchemaDocument, int type, java.lang.String text)
          Constructor
 
Method Summary
 void addDocumentListener(javax.swing.event.DocumentListener dl)
          Add a DocumentListener to the Text Box
 ReloadSchemaElement getSchemaElement()
          Get the schema element that is bound to this TextArea
 javax.swing.JTextArea getTextArea()
          Get the TextArea
 java.lang.String getTextValue()
          Get the Value on the TextArea
 java.lang.String getVdexSourcePath()
          Get the Vdex Source Path
 java.lang.String getVdexSourceValue()
          Get the Vdex Source Value
 void handleVdexBrowse()
          Handle Vdex Browsing.
 void insertTextValue(java.lang.String text)
          Insert some text into the TextArea
 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 setColumns(int columns)
          Set the maximum allowed number of columns for this TextArea
 void setEnabled(boolean enabled)
          Set the components enabled/disabled
 void setMaxLength(int maxLength)
          Set the maximum allowed number of characters
 void setSchemaElement(ReloadSchemaElement schemaElement)
          Set the schema element that is bound to this TextArea
protected  void setTabKeyBehaviour()
          Make sure we can use the Tab key for traversal
 void setTextValue(java.lang.String value)
          Set the Value on the TextArea
protected  void setUI()
          Set the UI
protected  void setupAction()
          Set up the button action.
 void setVdexSourcePath(java.lang.String vdexSourcePath)
          Set the Vdex Source Path
 void setVdexSourceValue(java.lang.String vdexSourceValue)
          Set the Vdex Source Value
 void setVdexValuesToDocument(java.lang.String[] vals)
          Set Vdex Vocabulary Values selected on the Browser to ReloadDocument
protected  void showWarningMessage(java.lang.String msg)
          Warn the user that a source vdex file was not choosen.
 void updateUI()
          Update the UI
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI
 
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


_textArea

protected javax.swing.JTextArea _textArea
A JTextArea to display the value


_button

protected javax.swing.JButton _button
A button for browing Vdex vocabulary values


_text

protected java.lang.String _text
The text to display on button


_type

protected int _type
The button type


_vdexSourcePath

protected java.lang.String _vdexSourcePath
The Vdex Source Path, that is the source element that has the Vocabulary Name or Identifier of the Vdex file that we have to use for browsing


_vdexSourceValue

protected java.lang.String _vdexSourceValue
The Vdex Source Value, that is the Vocabulary Name or Identifier of the Vdex file that we will use for browsing


VDEX_BROWSE_TYPE

public static int VDEX_BROWSE_TYPE
Type of button - BROWSE_TYPE


_reloadSchemaDocument

protected ReloadSchemaDocument _reloadSchemaDocument
The Reload Schema Document


_schemaElement

protected ReloadSchemaElement _schemaElement
The Reload Schema Element bound to the JTextPane

Constructor Detail

ReloadButtonTextArea

public ReloadButtonTextArea(ReloadSchemaDocument reloadSchemaDocument,
                            int type,
                            java.lang.String text)
Constructor

Parameters:
reloadSchemaDocument - the owner document
type - the button type (for example Vdex Browse Button)
text - the text to display on the button
Method Detail

setTabKeyBehaviour

protected void setTabKeyBehaviour()
Make sure we can use the Tab key for traversal


setUI

protected void setUI()
Set the UI


setupAction

protected void setupAction()
Set up the button action. If the button type is Vdex Browse, then it opens a MetadataVdexBrowser.


getTextArea

public javax.swing.JTextArea getTextArea()
Get the TextArea

Returns:
the TextArea

setColumns

public void setColumns(int columns)
Set the maximum allowed number of columns for this TextArea

Parameters:
columns - maximum allowed number of columns for this TextArea

setTextValue

public void setTextValue(java.lang.String value)
Set the Value on the TextArea

Specified by:
setTextValue in interface ReloadWidget
Parameters:
value - the value to be set on the TextArea

insertTextValue

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

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

getTextValue

public java.lang.String getTextValue()
Get the Value on the TextArea

Specified by:
getTextValue in interface ReloadWidget
Returns:
the value on the TextArea

setMaxLength

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

Specified by:
setMaxLength in interface ReloadWidget
Parameters:
maxLength - the maximum 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 only needs a single line to display itself, false otherwise

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 it

updateUI

public void updateUI()
Update the UI


setVdexSourcePath

public void setVdexSourcePath(java.lang.String vdexSourcePath)
Set the Vdex Source Path

Parameters:
vdexSourcePath - the vdex source path

getVdexSourcePath

public java.lang.String getVdexSourcePath()
Get the Vdex Source Path

Returns:
the vdex source path

setVdexSourceValue

public void setVdexSourceValue(java.lang.String vdexSourceValue)
Set the Vdex Source Value

Parameters:
vdexSourceValue -

getVdexSourceValue

public java.lang.String getVdexSourceValue()
Get the Vdex Source Value

Returns:
the vdex source value

setSchemaElement

public void setSchemaElement(ReloadSchemaElement schemaElement)
Set the schema element that is bound to this TextArea

Parameters:
schemaElement - the schema element that is bound to this TextArea

getSchemaElement

public ReloadSchemaElement getSchemaElement()
Get the schema element that is bound to this TextArea

Returns:
the schema element that is bound to this TextArea

handleVdexBrowse

public void handleVdexBrowse()
Handle Vdex Browsing. Gets the Vdex Source Value using the Vdex Source Path information.


showWarningMessage

protected void showWarningMessage(java.lang.String msg)
Warn the user that a source vdex file was not choosen. You need a Vdex Source Path to get the Vdex Source Value.

Parameters:
msg - the warning message to display in the dialog

setVdexValuesToDocument

public void setVdexValuesToDocument(java.lang.String[] vals)
Set Vdex Vocabulary Values selected on the Browser to ReloadDocument

Parameters:
vals - an array of string values

VdexReload 1.1.3 API