Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jmmv.ui
Class Form  view Form download Form.java

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended byjmmv.ui.Form
All Implemented Interfaces:
javax.accessibility.Accessible, javax.swing.event.ChangeListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.event.ItemListener, java.awt.event.KeyListener, java.awt.MenuContainer, java.io.Serializable

public abstract class Form
extends javax.swing.JPanel
implements java.awt.event.ItemListener, java.awt.event.KeyListener, javax.swing.event.ChangeListener

Form provides a base abstarct class to create forms in a GUI, using Swing components. The form is based on a JPanel which can be 'included' in any container. A form emits a ChangeEvent whenever the state of any form entry changes (i.e. a letter is added, an option is changed, etc). This allows parent frames to know when the state of the panel changes. The form data is based on jmmv.db.Register and derived classes, that provide a common and abstract way to access a database.


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
private  javax.swing.event.ChangeEvent changeEvent
           
protected  java.awt.GridBagLayout gbl
           
protected  boolean ignoreEvents
           
private  javax.swing.event.EventListenerList listenerList
           
 
Fields inherited from class javax.swing.JComponent
accessibleContext, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Container
 
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
Form()
           
 
Method Summary
 void addChangeListener(javax.swing.event.ChangeListener l)
           
protected  void addEntry(java.lang.String caption, DateEntry comp, boolean required)
          Adds a new entry to the form, based on a caption and a combobox field.
protected  void addEntry(java.lang.String caption, javax.swing.JComboBox comp, boolean required)
          Adds a new entry to the form, based on a caption and a combobox field.
protected  void addEntry(java.lang.String caption, javax.swing.JTextField comp, boolean required)
          Adds a new entry to the form, based on a caption and a text field.
abstract  void emptyFields()
          Clears form data, and sets default values for fields that can't be 'emptied', like comboboxes.
protected  void fireStateChanged()
           
abstract  jmmv.db.Register getRegister()
           
private  void internalAddEntry(java.lang.String caption, javax.swing.JComponent comp, boolean required)
          Adds a new entry to the form.
 void itemStateChanged(java.awt.event.ItemEvent evt)
          This action manager is used to enter updating mode when a field in the dialog, that allows item selection, is changed.
 void keyPressed(java.awt.event.KeyEvent evt)
          Unused
 void keyReleased(java.awt.event.KeyEvent evt)
          Unused
 void keyTyped(java.awt.event.KeyEvent evt)
          This action manager is used to enter updating mode when a field in the dialog, that allows text change, is edited.
 void removeChangeListener(javax.swing.event.ChangeListener l)
           
abstract  void setRegister(jmmv.db.Register r)
           
protected abstract  void showRegister()
          Shows the current register on the form.
 void stateChanged(javax.swing.event.ChangeEvent evt)
          Called by an object to notify the listener that the object's state has changed.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, 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, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

gbl

protected java.awt.GridBagLayout gbl

listenerList

private javax.swing.event.EventListenerList listenerList

changeEvent

private javax.swing.event.ChangeEvent changeEvent

ignoreEvents

protected boolean ignoreEvents
Constructor Detail

Form

public Form()
Method Detail

internalAddEntry

private final void internalAddEntry(java.lang.String caption,
                                    javax.swing.JComponent comp,
                                    boolean required)
Adds a new entry to the form. An entry is formed by a caption, that is converted into a JLabel, and a component, that can be any kind of Swing object. This function is private because it doesn't provide enough functionality to manage components.


addEntry

protected final void addEntry(java.lang.String caption,
                              javax.swing.JTextField comp,
                              boolean required)
Adds a new entry to the form, based on a caption and a text field. The text field will be connected to a KeyListener so that the dialog can enter 'update' mode when a text is modified.


addEntry

protected final void addEntry(java.lang.String caption,
                              javax.swing.JComboBox comp,
                              boolean required)
Adds a new entry to the form, based on a caption and a combobox field. The combobox will be connected to an EntryListener so that the dialog can enter 'update' mode when the option is changed.


addEntry

protected final void addEntry(java.lang.String caption,
                              DateEntry comp,
                              boolean required)
Adds a new entry to the form, based on a caption and a combobox field. The combobox will be connected to an EntryListener so that the dialog can enter 'update' mode when the option is changed.


showRegister

protected abstract void showRegister()
Shows the current register on the form. It must use the 'currentReg' variable, provided by the derived class.


emptyFields

public abstract void emptyFields()
Clears form data, and sets default values for fields that can't be 'emptied', like comboboxes.


getRegister

public abstract jmmv.db.Register getRegister()
                                      throws jmmv.db.InvalidDataException,
                                             java.sql.SQLException

setRegister

public abstract void setRegister(jmmv.db.Register r)

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent evt)
This action manager is used to enter updating mode when a field in the dialog, that allows item selection, is changed.

Specified by:
itemStateChanged in interface java.awt.event.ItemListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent evt)
This action manager is used to enter updating mode when a field in the dialog, that allows text change, is edited.

Specified by:
keyTyped in interface java.awt.event.KeyListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent evt)
Unused

Specified by:
keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent evt)
Unused

Specified by:
keyReleased in interface java.awt.event.KeyListener

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent evt)
Description copied from interface: javax.swing.event.ChangeListener
Called by an object to notify the listener that the object's state has changed. The incoming event identifies the source of the event, allowing the listener to differentiate when it is listening for changes in multiple sources.

Specified by:
stateChanged in interface javax.swing.event.ChangeListener

addChangeListener

public void addChangeListener(javax.swing.event.ChangeListener l)

removeChangeListener

public void removeChangeListener(javax.swing.event.ChangeListener l)

fireStateChanged

protected void fireStateChanged()