com.ontimize.gui.field
Class SubForm

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              com.ontimize.gui.field.AbstractFormComponent
                  com.ontimize.gui.field.IdentifiedAbstractFormComponent
                      com.ontimize.gui.field.SubForm

All Implemented Interfaces:

AccessForm, CreateForms, DataComponent, FormComponent, Freeable, IdentifiedElement, IFormComponentManager, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, OpenDialog, ReferenceComponent, SecureElement, java.io.Serializable, SubFormComponent

public class SubForm

extends IdentifiedAbstractFormComponent

implements CreateForms, OpenDialog, AccessForm, Freeable, ReferenceComponent, DataComponent, SubFormComponent, IFormComponentManager

This class allows to put a form into another form like a typical component. This subform is wrapped in a TableAttribute structure.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

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 Form	form
protected FormBuilder	formBuilder
protected FormManager	formManager
protected java.lang.String	formName
protected EntityReferenceLocator	locator
protected java.awt.Frame	parentFrame
protected java.util.Vector	parentKeys

Fields inherited from class com.ontimize.gui.field.IdentifiedAbstractFormComponent

attribute, enabledPermission, parentForm, restricted, visiblePermission

Fields inherited from class com.ontimize.gui.field.AbstractFormComponent

defaultBottomMargin, defaultLeftMargin, defaultRightMargin, defaultTopMargin

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 com.ontimize.gui.field.FormComponent

DEBUG

Fields inherited from interface com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.field.DataComponent

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SubForm(java.util.Hashtable params)

Method Summary

protected void	createForm()
void	deleteData() The method to delete data for component.
void	free() Makes the object to release the resources.
java.lang.Object	getAttribute() Gets the object attribute.
Form	getForm() Get an instance of the subform component
java.lang.String	getLabelComponentText() Returns the label text component.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
java.lang.Object	getValue() Gets the value of a component.
void	init(java.util.Hashtable params) Initializes parameters.
boolean	isEmpty() Checks the data existence in component.
boolean	isHidden() Indicates to check the visibility condition for a component.
boolean	isModifiable() Checks the modifiable condition for a component.
boolean	isModified() This method should be return true when data have been modified.
boolean	isRequired() Indicates the required condition for a component.
void	setComponentLocale(java.util.Locale l)
void	setEnabled(boolean enabled) Disable all form fields and navigation buttons
void	setFormBuilder(FormBuilder constructor)
void	setFormManager(FormManager formManager)
void	setInsertMode()
void	setModifiable(boolean modificable) Establishes the modifiable condition for a component.
void	setParentForm(Form f) Method declaration to set the form that contains the component.
void	setParentFrame(java.awt.Frame parentFrame) This method is called from Form for each component that implements this interface.
void	setParentKeys() Method to set the value in subform parentkeys fields
void	setQueryInsertMode()
void	setReferenceLocator(EntityReferenceLocator referenceLocator) Establishes the reference locator that will be used by component.
void	setRequired(boolean required) Sets required a component according to condition.
void	setResourceBundle(java.util.ResourceBundle res) Sets the language resource bundle.
void	setUpdateMode()
void	setValue(java.lang.Object value) Sets the value for component.

Methods inherited from class com.ontimize.gui.field.IdentifiedAbstractFormComponent

checkEnabledPermission, checkVisiblePermission, getParentForm, initPermissions, isRestricted

Methods inherited from class com.ontimize.gui.field.AbstractFormComponent

getConstraints, getTextsToTranslate

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, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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

Methods inherited from interface com.ontimize.gui.field.FormComponent

getConstraints, isEnabled, setVisible

Methods inherited from interface com.ontimize.gui.i18n.Internationalization

getTextsToTranslate

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

formName

protected java.lang.String formName

form

protected Form form

parentFrame

protected java.awt.Frame parentFrame

locator

protected EntityReferenceLocator locator

formBuilder

protected FormBuilder formBuilder

parentKeys

protected java.util.Vector parentKeys

formManager

protected FormManager formManager

Constructor Detail

SubForm

public SubForm(java.util.Hashtable params)
        throws java.lang.Exception

Method Detail

free

public void free()
          throws java.lang.Exception

Description copied from interface: Freeable

Makes the object to release the resources.

Specified by:

free in interface Freeable

Throws:

java.lang.Exception

setParentFrame

public void setParentFrame(java.awt.Frame parentFrame)

Description copied from interface: OpenDialog

This method is called from Form for each component that implements this interface. It fixes the parent frame for element. This frame is needed to open the modal dialog.

Specified by:

setParentFrame in interface OpenDialog

Parameters:

parentFrame - the frame

getAttribute

public java.lang.Object getAttribute()

Description copied from interface: IdentifiedElement

Gets the object attribute. This attribute allows to identify the object

Specified by:

getAttribute in interface IdentifiedElement

Overrides:

getAttribute in class IdentifiedAbstractFormComponent

setFormBuilder

public void setFormBuilder(FormBuilder constructor)

Specified by:

setFormBuilder in interface CreateForms

init

public void init(java.util.Hashtable params)

Initializes parameters.

Specified by:

init in interface FormComponent

Overrides:

init in class IdentifiedAbstractFormComponent

Parameters:

params - the Hashtable with parameters. Adds the next parameters:

attribute	values	default	required	meaning
form			yes	The complete path to the subform. For example, "com/ontimize/form/form.xml"

setParentForm

public void setParentForm(Form f)

Description copied from interface: AccessForm

Method declaration to set the form that contains the component. This method must be called automatically during the form building.

Specified by:

setParentForm in interface AccessForm

Overrides:

setParentForm in class IdentifiedAbstractFormComponent

setReferenceLocator

public void setReferenceLocator(EntityReferenceLocator referenceLocator)

Description copied from interface: ReferenceComponent

Establishes the reference locator that will be used by component. This method is automatically called by Form when it is being loaded.

Specified by:

setReferenceLocator in interface ReferenceComponent

Parameters:

referenceLocator - a reference locator to set in component

getLabelComponentText

public java.lang.String getLabelComponentText()

Description copied from interface: DataComponent

Returns the label text component. This label will change according to the Locale.

Specified by:

getLabelComponentText in interface DataComponent

Returns:

the label text

getValue

public java.lang.Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Returns:

the object with value.

setValue

public void setValue(java.lang.Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Parameters:

value - the object with value to set

deleteData

public void deleteData()

Description copied from interface: DataComponent

The method to delete data for component.

Specified by:

deleteData in interface DataComponent

setParentKeys

public void setParentKeys()

Method to set the value in subform parentkeys fields

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Returns:

true when component is empty

isModifiable

public boolean isModifiable()

Description copied from interface: DataComponent

Checks the modifiable condition for a component. It is useful when it is not desired form deletes a component value.

Specified by:

isModifiable in interface DataComponent

Returns:

true when component is modifiable

setModifiable

public void setModifiable(boolean modificable)

Description copied from interface: DataComponent

Establishes the modifiable condition for a component. When component is not modifiable, data will not be deleted automatically in DeleteFields call.

Specified by:

setModifiable in interface DataComponent

Parameters:

modificable - the boolean condition

isHidden

public boolean isHidden()

Description copied from interface: DataComponent

Indicates to check the visibility condition for a component.

Specified by:

isHidden in interface DataComponent

Returns:

the visibility condition

getSQLDataType

public int getSQLDataType()

Description copied from interface: DataComponent

Returns the sql data type according to java.sql.Types

Specified by:

getSQLDataType in interface DataComponent

Returns:

the Integer type

isRequired

public boolean isRequired()

Description copied from interface: DataComponent

Indicates the required condition for a component.

Specified by:

isRequired in interface DataComponent

Returns:

the required condition

isModified

public boolean isModified()

Description copied from interface: DataComponent

This method should be return true when data have been modified. The method setValue() should be change this condition.

Specified by:

isModified in interface DataComponent

Returns:

the modified condition

setRequired

public void setRequired(boolean required)

Description copied from interface: DataComponent

Sets required a component according to condition.

Specified by:

setRequired in interface DataComponent

Parameters:

required - the required condition

setFormManager

public void setFormManager(FormManager formManager)

Specified by:

setFormManager in interface SubFormComponent

createForm

protected void createForm()

getForm

public Form getForm()

Description copied from interface: SubFormComponent

Get an instance of the subform component

Specified by:

getForm in interface SubFormComponent

Returns:

setEnabled

public void setEnabled(boolean enabled)

Disable all form fields and navigation buttons

Specified by:

setEnabled in interface FormComponent

setUpdateMode

public void setUpdateMode()

setQueryInsertMode

public void setQueryInsertMode()

setInsertMode

public void setInsertMode()

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle res)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Overrides:

setResourceBundle in class AbstractFormComponent

setComponentLocale

public void setComponentLocale(java.util.Locale l)

Specified by:

setComponentLocale in interface Internationalization

Overrides:

setComponentLocale in class AbstractFormComponent