cdx.scorebot.util.swing.binding
Class JTextPaneBound<FROM>

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent
                  javax.swing.JEditorPane
                      javax.swing.JTextPane
                          cdx.scorebot.util.swing.binding.JTextPaneBound<FROM>

All Implemented Interfaces:

BoundComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.Scrollable

public class JTextPaneBound<FROM>
extends javax.swing.JTextPane
implements BoundComponent

Describes a text area which holds a value of type FROM as a String

Author:

David Underhill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JEditorPane

javax.swing.JEditorPane.AccessibleJEditorPane, javax.swing.JEditorPane.AccessibleJEditorPaneHTML, javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

Nested classes/interfaces inherited from class javax.swing.text.JTextComponent

javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.DropLocation, javax.swing.text.JTextComponent.KeyBinding

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

Fields inherited from class javax.swing.JEditorPane

HONOR_DISPLAY_PROPERTIES, W3C_LENGTH_UNITS

Fields inherited from class javax.swing.text.JTextComponent

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

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

JTextPaneBound()
Instantiates an unbound JTextPaneBound

JTextPaneBound(java.lang.Object boundItem, java.lang.String varName)
Instantiates a bound JTextPane; generic type MUST be String

JTextPaneBound(java.lang.Object boundItem, java.lang.String getterName, java.lang.String setterName)
Instantiates a bound JTextPane; generic type MUST be String

JTextPaneBound(java.lang.Object boundItem, java.lang.String getterName, java.lang.String setterName, int indexAt)
Instantiates a bound JTextPane; generic type MUST be String

JTextPaneBound(java.lang.String varName)
Instantiates an unbound JTextPane; generic type MUST be String

JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator, java.lang.Object boundItem, java.lang.String varName)
Instantiates a bound JTextPane

JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator, java.lang.Object boundItem, java.lang.String getterName, java.lang.String setterName)
Instantiates a bound JTextPane

JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator, java.lang.Object boundItem, java.lang.String getterName, java.lang.String setterName, int indexAt)
Instantiates a bound JTextPane

JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator, java.lang.String varName)
Instantiates an unbound JTextPane

Method Summary

JTextComponentDelegate<FROM>

getBindingDelegate() gets the delete which controls the binding

Methods inherited from class javax.swing.JTextPane

addStyle, createDefaultEditorKit, getCharacterAttributes, getInputAttributes, getLogicalStyle, getParagraphAttributes, getStyle, getStyledDocument, getStyledEditorKit, getUIClassID, insertComponent, insertIcon, paramString, removeStyle, replaceSelection, setCharacterAttributes, setDocument, setEditorKit, setLogicalStyle, setParagraphAttributes, setStyledDocument

Methods inherited from class javax.swing.JEditorPane

addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText

Methods inherited from class javax.swing.text.JTextComponent

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getDropLocation, getDropMode, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getPrintable, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, print, print, print, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setDropMode, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, 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, 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, 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, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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

JTextPaneBound

public JTextPaneBound()

Instantiates an unbound JTextPaneBound

JTextPaneBound

public JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator,
                      java.lang.String varName)

Instantiates an unbound JTextPane

Parameters:

translator - how to translate between the value in the boundItem (type FROM) a another value of type TO

varName - the name of the variable; assumes the getter and setter name will be get and set followed by varName with its first letter capitalized (ex: if varName is "value" then the getter will be getValue).

JTextPaneBound

public JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator,
                      java.lang.Object boundItem,
                      java.lang.String varName)

Instantiates a bound JTextPane

Parameters:

translator - how to translate between the value in the boundItem (type FROM) a another value of type TO

boundItem - the object this is bound to (contains the value to be modified as specified by varName)

varName - the name of the variable; assumes the getter and setter name will be get and set followed by varName with its first letter capitalized (ex: if varName is "value" then the getter will be getValue).

JTextPaneBound

public JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator,
                      java.lang.Object boundItem,
                      java.lang.String getterName,
                      java.lang.String setterName)

Instantiates a bound JTextPane

Parameters:

translator - how to translate between the value in the boundItem (type FROM) a another value of type TO

boundItem - the object this is bound to (contains the value to be modified as specified by the getter and setter name)

getterName - how to get the bound value from the bound object

setterName - how to set the bound value from the bound object

JTextPaneBound

public JTextPaneBound(TypeTranslator<FROM,java.lang.String> translator,
                      java.lang.Object boundItem,
                      java.lang.String getterName,
                      java.lang.String setterName,
                      int indexAt)

Instantiates a bound JTextPane

Parameters:

translator - how to translate between the value in the boundItem (type FROM) a another value of type TO

boundItem - the object this is bound to (contains the value to be modified as specified by the getter and setter name)

getterName - how to get the bound value from the bound object

setterName - how to set the bound value from the bound object

indexAt - if bound value is stored within a container with get(index) and set(index, Object) methods, then indexAt should be the index to use; otherwise, indexAt should be -1

JTextPaneBound

public JTextPaneBound(java.lang.String varName)

Instantiates an unbound JTextPane; generic type MUST be String

Parameters:

varName - the name of the variable; assumes the getter and setter name will be get and set followed by varName with its first letter capitalized (ex: if varName is "value" then the getter will be getValue).

JTextPaneBound

public JTextPaneBound(java.lang.Object boundItem,
                      java.lang.String varName)

Instantiates a bound JTextPane; generic type MUST be String

Parameters:

boundItem - the object this is bound to (contains the value to be modified as specified by varName)

varName - the name of the variable; assumes the getter and setter name will be get and set followed by varName with its first letter capitalized (ex: if varName is "value" then the getter will be getValue).

JTextPaneBound

public JTextPaneBound(java.lang.Object boundItem,
                      java.lang.String getterName,
                      java.lang.String setterName)

Instantiates a bound JTextPane; generic type MUST be String

Parameters:

boundItem - the object this is bound to (contains the value to be modified as specified by the getter and setter name)

getterName - how to get the bound value from the bound object

setterName - how to set the bound value from the bound object

JTextPaneBound

public JTextPaneBound(java.lang.Object boundItem,
                      java.lang.String getterName,
                      java.lang.String setterName,
                      int indexAt)

Instantiates a bound JTextPane; generic type MUST be String

Parameters:

boundItem - the object this is bound to (contains the value to be modified as specified by the getter and setter name)

getterName - how to get the bound value from the bound object

setterName - how to set the bound value from the bound object

indexAt - if bound value is stored within a container with get(index) and set(index, Object) methods, then indexAt should be the index to use; otherwise, indexAt should be -1

Method Detail

getBindingDelegate

public JTextComponentDelegate<FROM> getBindingDelegate()

gets the delete which controls the binding

Specified by:

getBindingDelegate in interface BoundComponent