JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.datasource.swing
Class DSdbJTextArea

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextArea
                                |
                                +--com.klg.jclass.datasource.swing.DSdbJTextArea
All Implemented Interfaces:
Accessible, EventListener, FocusListener, ImageObserver, KeyListener, MenuContainer, Scrollable, Serializable

public class DSdbJTextArea
extends JTextArea
implements FocusListener, KeyListener

This class binds a JTextArea to a column in the current row of the datasource. Changing the value updates the record in the datasource but does not automatically commit the change. Control-Enter and lost focus initiates the update.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JTextArea
JTextArea.AccessibleJTextArea
 
Nested classes inherited from class javax.swing.text.JTextComponent
JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding
 
Nested classes inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
protected static String nullDatabindingText
           
protected  int textMargin
           
 
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
DSdbJTextArea()
          Creates a new DSdbJTextArea component.
DSdbJTextArea(com.klg.jclass.datasource.BindingModel binding, String columnName)
          Create and bind to a Binding
DSdbJTextArea(com.klg.jclass.datasource.DataModel dataModel, com.klg.jclass.datasource.MetaDataModel metaDataModel, String columnName)
          Creates a new DSdbJTextArea component and binds it to a particular column in a MetaDataModel.
 
Method Summary
 void focusGained(FocusEvent event)
          Called when the text field gets focus.
 void focusLost(FocusEvent event)
          Commits any changes when the text field loses focus.
 String getDataBinding()
          Returns the data binding hierarchy string, starting from a JCTreeData instance name and containing full sequence of MetaDataModel levels starting from the root to the level the table is bound with.
 Dimension getMinimumSize()
          Returns the minimum size of the component.
 Dimension getPreferredSize()
          Returns the preferred size of the component.
 void keyPressed(KeyEvent event)
          Called when a key is pressed.
 void keyReleased(KeyEvent event)
          Called when a key is released.
 void keyTyped(KeyEvent event)
          Called when a key is typed.
 void paint(Graphics gc)
          Override to display default text if unbound.
 void setDataBinding(com.klg.jclass.datasource.BindingModel b, String columnName)
          Bind to the specified Binding.
 void setDataBinding(com.klg.jclass.datasource.DataModel dataModel, com.klg.jclass.datasource.MetaDataModel metaDataModel, String columnName)
          Sets the parameters for binding the component to a particular column in a MetaDataModel.
 void setDataBinding(com.klg.jclass.datasource.DataModel dataModel, String metaPath)
          Sets the data source to a DataModel and binds the MetaData to the MetaDataModel represented by a "path" of MetaDataModel descriptions separated by '|' (e.g.
 void setDataBinding(String dataBinding)
          Sets the data source to the path of DataModel, MetaDataModel descriptions and column name.
 
Methods inherited from class javax.swing.JTextArea
append, createDefaultModel, getAccessibleContext, getColumns, getColumnWidth, getLineCount, getLineEndOffset, getLineOfOffset, getLineStartOffset, getLineWrap, getPreferredScrollableViewportSize, getRowHeight, getRows, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getTabSize, getUIClassID, getWrapStyleWord, insert, paramString, replaceRange, setColumns, setFont, setLineWrap, setRows, setTabSize, setWrapStyleWord
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write
 
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, getNextFocusableComponent, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, 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, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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
 

Field Detail

nullDatabindingText

protected static final String nullDatabindingText
See Also:
Constant Field Values

textMargin

protected int textMargin
Constructor Detail

DSdbJTextArea

public DSdbJTextArea()
Creates a new DSdbJTextArea component.


DSdbJTextArea

public DSdbJTextArea(com.klg.jclass.datasource.DataModel dataModel,
                     com.klg.jclass.datasource.MetaDataModel metaDataModel,
                     String columnName)
Creates a new DSdbJTextArea component and binds it to a particular column in a MetaDataModel.

See Also:
NodeProperties.setDataSource(java.lang.Object)

DSdbJTextArea

public DSdbJTextArea(com.klg.jclass.datasource.BindingModel binding,
                     String columnName)
Create and bind to a Binding

Method Detail

setDataBinding

public void setDataBinding(com.klg.jclass.datasource.DataModel dataModel,
                           com.klg.jclass.datasource.MetaDataModel metaDataModel,
                           String columnName)
Sets the parameters for binding the component to a particular column in a MetaDataModel. If the MetaDataModel is the root in the DataModel's MetaDataTree, the DataTableModel is automatically set to the root DataTableModel, otherwise, the DataTableModel is set when an appropriate table becomes available.


setDataBinding

public void setDataBinding(com.klg.jclass.datasource.DataModel dataModel,
                           String metaPath)
Sets the data source to a DataModel and binds the MetaData to the MetaDataModel represented by a "path" of MetaDataModel descriptions separated by '|' (e.g. Orders|Customers).


setDataBinding

public void setDataBinding(String dataBinding)
Sets the data source to the path of DataModel, MetaDataModel descriptions and column name.


setDataBinding

public void setDataBinding(com.klg.jclass.datasource.BindingModel b,
                           String columnName)
Bind to the specified Binding.

Parameters:
columnName - the column to which this component will be bound.

getDataBinding

public String getDataBinding()
Returns the data binding hierarchy string, starting from a JCTreeData instance name and containing full sequence of MetaDataModel levels starting from the root to the level the table is bound with.


focusGained

public void focusGained(FocusEvent event)
Called when the text field gets focus.

Specified by:
focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent event)
Commits any changes when the text field loses focus.

Specified by:
focusLost in interface FocusListener

keyPressed

public void keyPressed(KeyEvent event)
Called when a key is pressed. Saves any changes to the data source.

Specified by:
keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent event)
Called when a key is released.

Specified by:
keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent event)
Called when a key is typed.

Specified by:
keyTyped in interface KeyListener

paint

public void paint(Graphics gc)
Override to display default text if unbound.

Overrides:
paint in class JComponent

getPreferredSize

public Dimension getPreferredSize()
Returns the preferred size of the component.

Overrides:
getPreferredSize in class JTextArea

getMinimumSize

public Dimension getMinimumSize()
Returns the minimum size of the component.

Overrides:
getMinimumSize in class JComponent

Copyright © 2004 Quest Software Inc..
All rights reserved.