BaseFormManager (ontimize-core 5.6.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.ontimize.gui.manager.BaseFormManager

All Implemented Interfaces:

DataNavigationListener, FontAndEncodingSelector, Freeable, Internationalization, IFormManager, SecureElement, SelectCurrencyValues, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

FormManager, TabbedFormManager
```
public abstract class BaseFormManager
extends JPanel
implements IFormManager
```
The FormManager is used to create, register and manage a group of form.

Author:

Imatia Innovation

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field and Description
`protected Application`	`application` Application reference
`protected Frame`	`applicationFrame` Application frame reference.
`protected ApplicationPreferences`	`aPreferences` The `ApplicationPreferences` reference
`protected JPanel`	`auxPanel`
`protected String`	`baseCP` Base Classpath used whether the useClasspath condition is setted to true
`protected boolean`	`checkModifiedDataForms`
`protected String`	`currentForm` The form name that is visible in this `FormManager`
`static String`	`defaultInteractionManagerLoader`
`protected boolean`	`delayedLoad` If this condition is setted to true,this `FormManager` will not be loaded when is instanced, that is, the initial `Form` class, `InteractionManager` class, and `Tree` class will not be instanced until the `FormManager` is called for first time.
`protected String`	`dynamicFormClass`
`protected FormBuilder`	`formBuilder` FormBuilder reference
`protected DynamicFormManager`	`formDynamicManager`
`protected Hashtable`	`formInteractionManagerActionList` A `Hashtable` with the interaction manager class name assigned to each action handler.
`protected Hashtable<String,String>`	`formInteractionManagerClassNameList` A `Hashtable` with the interaction manager class name assigned to each form.
`protected Hashtable`	`formManagerForms`
`protected Hashtable`	`formModifiableFields`
`protected Hashtable<String,Form>`	`formReferenceList` A `Hashtable` with a form list where the key is the form name and the value a `Form` class instance.
`protected Vector`	`formRegisteredDataNavigationListener` A list formed by the forms where this `FormManager` has been registered as a `DataNavigationListener` in.
`protected Hashtable`	`formRules` The `Hashtable` key is the form name and the `Hashtable` value is the `RuleEngine` XML definition location.
`protected String`	`icon`
`protected String`	`id` A `String` with the identifier of this `FormManager`
`protected InteractionManagerLoader`	`iManagerLoader`
`protected String`	`initialForm` The `Form` name that will be shown at first
`protected InteractionManager`	`initialInteractionManager` The `InteractionManager` reference of the form that will be shown at first
`protected Hashtable<String,InteractionManager>`	`interactionManagerList` A `Hashtable` with the interaction manager to be registered.
`protected String`	`interactionManagerLoader`
`protected Vector`	`interactionManagers`
`protected boolean`	`loadedForm` If this condition is true, the `FormManager` will be loaded.
`protected List<String>`	`loadedList` Form list that are loaded and layout
`protected Locale`	`locale` Locale
`protected EntityReferenceLocator`	`locator` Entity reference locator reference
`static String`	`M_MODIFIED_DATA` GUI Text
`static String`	`M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE` GUI Text
`protected JPanel`	`panelTop` Panel used to add new buttons at `FormManager`
`protected Container`	`parent` Container where is stored this component in
`protected boolean`	`preferenceListenersRegistered` Condition used to register the preference listener only one time
`protected boolean`	`processDataChangeEvents` The FormManager will dispatch the DataNavigationEvent if this is true
`protected ResourceBundle`	`resourceFile` ResourceBundle reference
`protected String`	`resourceFileName` ResourceBundle file name
`protected boolean`	`restricted`
`protected RuleEngine`	`ruleEngine`
`protected RuleEngineLoader`	`ruleEngineLoader`
`protected String`	`rules` The complete path for rule file for initial form.
`protected boolean`	`setResourceBundleOnLoad`
`protected boolean`	`showFrame`
`protected String`	`uRIBase` Base URI used to obtain the form file.
`protected boolean`	`useClasspath` Condition that determine whether the 'form' attribute value specified a location relative to the classpath.
`protected FMPermission`	`visiblePermission`

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.manager.IFormManager
ACTION, APPLICATION, CONTAINER, DELAYED_LOAD, DETAIL, DYNAMIC_FORM, FORM, FORM_BUILDER, FRAME, ICON, ID, IM_LOADER, INTERACTION_MANAGER, LOAD, LOCATOR, RESOURCES, RULE_LOADER, RULES, SHOW_FRAME, USE_CLASS_PATH

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

Fields inherited from interface com.ontimize.gui.SecureElement
DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Fields inherited from interface com.ontimize.gui.SelectCurrencyValues
EURO, PST

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`BaseFormManager(Frame frame, Container container, FormBuilder builder, String formURI, InteractionManager interactionManager, ResourceBundle resource, boolean northPanel)` Builds a `FormManager`
`BaseFormManager(Frame frame, Container container, FormBuilder builder, String formURI, ResourceBundle resource)` Builds a `FormManager`
`BaseFormManager(Frame frame, Container container, FormBuilder builder, String formURI, ResourceBundle resource, boolean northPanel)` Builds a `FormManager`
`BaseFormManager(Hashtable parameters)` Creates a FormManager instance with the parameters establishes in `Hastable`.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract void`	`addFormToContainer(JPanel panelForm, String formName)`
`void`	`addTopComponent(Component component)` Adds the component that is passed as entry parameter to `IFormManager#panelTop`
`protected void`	`applyInteractionManager(String interactionManagerClass, String formName)` Creates the `InteractionManager` class instance and call the `setInteractionManager(InteractionManager, String)`
`protected boolean`	`checkVisiblePermission(String id)` Checks if this `FormManager` is restricted with visible permissions
`protected void`	`configureRules(String formFileName)`
`protected abstract JComponent`	`createCenterPanel()`
`protected void`	`createLayout(Frame frame, Container container, FormBuilder builder, String formURI, InteractionManager interactionManager, ResourceBundle resource, boolean northPanel)`
`void`	`dataChanged(DataNavigationEvent e)` Notifies that the data in the form has changed.
`boolean`	`dataWillChange(DataNavigationEvent e)` Called when a form is going to change the status.
`protected void`	`finalize()`
`void`	`free()` Makes the object to release the resources.
`Form`	`getActiveForm()` Returns the active `Form` reference.
`Application`	`getApplication()` Gets the `Application` reference.
`protected Object`	`getAttributeValue(Object attribute, OTreeNode node)` Gets the attribute value into the `OTreeNode` that is passed as entry parameter.
`Container`	`getContainer()` Gets the container where the `FormManager` is layered out in.
`String`	`getCurrentForm()` Gets the `Form` name that is currently visible.
`boolean`	`getDelayedLoad()` Gets the delayed load condition
`FormBuilder`	`getFormBuilder()`
`Form`	`getFormCopy(String formName)` Gets a `Form` instance copy which form name is passed as entry parameter.
`Form`	`getFormCopy(String formName, Container container)` Gets a `Form` instance copy which form name is passed as entry parameter.
`Form`	`getFormCopy(String formResourceName, String imQualifiedName)` Gets a `Form` instance copy which form resource name is passed as entry parameter.
`Form`	`getFormCopyInEDTh(String formName)`
`protected Form`	`getFormCopyInEDTh(String formName, Container container)` Gets a `Form` instance copy which form name is passed as entry parameter.
`protected Form`	`getFormCopyInEDTh(String formResourceName, String imQualifiedName)` Gets a `Form` instance copy which form resource name is passed as entry parameter.
`Form`	`getFormCopyWithoutInteractionManager(String formName)` Gets a `Form` instance copy which form name is passed as entry parameter.
`Form`	`getFormCopyWithoutInteractionManager(String formName, Container container)` Gets a `Form` instance copy which form name is passed as entry parameter.
`Form`	`getFormCopyWithoutInteractionManagerInEDTh(String formName, Container container)` Gets a `Form` instance copy which form name is passed as entry parameter.
`Form`	`getFormReference(String form)` Gets a `Form` reference which name is passed as entry parameter.
`Form`	`getFormReference(String formName, boolean loadIfNecessary)` Gets the form reference which name is passed as entry parameter.
`String`	`getIcon()` Determines the icon that should be shown in a new Frame
`String`	`getId()` Gets the unique identifier for this `FormManager`
`InteractionManager`	`getInteractionManager(String formName)`
`String`	`getLabelFileURI()`
`EntityReferenceLocator`	`getReferenceLocator()` Gets the `EntityReferenceLocator` reference that is stored inside.
`ResourceBundle`	`getResourceBundle()` Gets the `ResourceBundle` reference stored in this `FormManager`
`String`	`getResourceFileName()` Gets the `ResourceBundle` name stored in this `FormManager`
`RuleEngine`	`getRuleEngine()`
`Vector`	`getTextsToTranslate()` Returns all the texts in the element suitable for being translated.
`URL`	`getURL(String formName)` Gets the Form URL which name is passed as entry parameter.
`void`	`init(Hashtable parameters)`
`void`	`initPermissions()`
`boolean`	`isLoaded()`
`boolean`	`isRestricted()`
`void`	`load()` Loads the `FormManager`.The initial `Form`, initial `InteractionManager` and `Tree` are instanced and are layered out in container to be shown.
`protected void`	`loadForm(String fileName)`
`protected void`	`loadFormInEDTh(String formFileName)` Loads the Form which file name is passed as entry parameter.
`void`	`loadForms(List<String> formList)` Loads the form list from `Vector` instance that are passed as entry parameter.
`void`	`loadInEDTh()` Loads the `FormManager`.
`void`	`reload(Form form)` Reload the `Form` that is passed as entry parameter.
`void`	`saveTextsToTranslate(String file, boolean append, Vector keys, Properties importProp)` Stores in the file which name is passed as entry parameters all texts in the `FormManager` that must be translated.
`void`	`setActiveForm(Form f)`
`void`	`setApplication(Application application)` Sets the `Application` reference.
`void`	`setApplicationPreferences(ApplicationPreferences ap)`
`void`	`setCheckModifiedFormData(boolean check)` Enables/disables the check of modified form data
`void`	`setComponentLocale(Locale l)`
`void`	`setFormManagerToForm(String formName, String formManagerId)` Stores in the `formManagerForms` variable the `FormManager` unique identifier and the `Form` name that are passed as entry parameter.
`void`	`setId(String id)` Sets the unique identifier for this `FormManager`
`void`	`setInteractionManager(InteractionManager interactionManager, String formName)` Registers the `InteractionManager` which is passed as entry parameter to the Form which name is passed as entry parameter as well.
`void`	`setInteractionManager(String interactionManagerClass, String formName)` Sets the `InteractionManager` for a `Form which file name is passed as entry parameter.`
`protected void`	`setQueryInsertMode(Form form)`
`void`	`setReferenceLocator(EntityReferenceLocator locator)` Sets the `EntityReferenceLocator` reference used in this `FormManager`
`protected void`	`setResourceBundle_internal()`
`void`	`setResourceBundle(ResourceBundle resources)` Sets the language resource bundle.
`void`	`setRuleEngine(RuleEngine ruleEngine)`
`protected void`	`setUpdateMode(Form form)`
`Font`	`showAvaliableFonts(boolean supportingEuro)` Shows the available fonts in the system.
`void`	`showCurrencyValue(String currencySymbol)`
`boolean`	`showForm(String formName)` Shows the form which file name is passed as entry parameter If this form isn't loaded, this method will load the form.
`boolean`	`showFrame()` Determines whether this FormManager should be shown in a new Frame.
`static boolean`	`supportsEuroSymbol(Font font)` Checks if the euro symbol can be displayed by the `Font` that is passed as entry parameter.
`protected void`	`updateInteractionDynamicFormMode(Form form)`
`void`	`useFont(Font f)` Set the font to use by the object

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, 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, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, 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, processInputMethodEvent, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ontimize.gui.manager.IFormManager
getLocale, showFormInEDTh

Field Detail
- M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE
```
public static String M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE
```
  GUI Text
- M_MODIFIED_DATA
```
public static String M_MODIFIED_DATA
```
  GUI Text
- applicationFrame
```
protected Frame applicationFrame
```
  Application frame reference.
- panelTop
```
protected JPanel panelTop
```
  Panel used to add new buttons at FormManager
- parent
```
protected Container parent
```
  Container where is stored this component in
- loadedList
```
protected List<String> loadedList
```
  Form list that are loaded and layout
- locale
```
protected Locale locale
```
  Locale
- formReferenceList
```
protected Hashtable<String,Form> formReferenceList
```
  A Hashtable with a form list where the key is the form name and the value a Form class instance.
- uRIBase
```
protected String uRIBase
```
  Base URI used to obtain the form file.
- useClasspath
```
protected boolean useClasspath
```
  Condition that determine whether the 'form' attribute value specified a location relative to the classpath.
- baseCP
```
protected String baseCP
```
  Base Classpath used whether the useClasspath condition is setted to true
- locator
```
protected EntityReferenceLocator locator
```
  Entity reference locator reference
- interactionManagerList
```
protected Hashtable<String,InteractionManager> interactionManagerList
```
  A Hashtable with the interaction manager to be registered. The Hashtable key is the form name and the Hashtable value is the InteractionManager class instance.
- formInteractionManagerClassNameList
```
protected Hashtable<String,String> formInteractionManagerClassNameList
```
  A Hashtable with the interaction manager class name assigned to each form. The Hashtable key is the form name and the Hashtable value is the InteractionManager class name.
- formInteractionManagerActionList
```
protected Hashtable formInteractionManagerActionList
```
  A Hashtable with the interaction manager class name assigned to each action handler. The Hashtable key is the form name and the Hashtable value is the InteractionManagerAction XML definition location.
  
  Since:
  
  Ontimize 5.2059EN
- formRules
```
protected Hashtable formRules
```
  The Hashtable key is the form name and the Hashtable value is the RuleEngine XML definition location.
  
  Since:
  
  Ontimize 5.2075EN
- currentForm
```
protected String currentForm
```
  The form name that is visible in this FormManager
- resourceFileName
```
protected String resourceFileName
```
  ResourceBundle file name
- resourceFile
```
protected ResourceBundle resourceFile
```
  ResourceBundle reference
- formBuilder
```
protected FormBuilder formBuilder
```
  FormBuilder reference
- auxPanel
```
protected JPanel auxPanel
```
- interactionManagers
```
protected Vector interactionManagers
```
- checkModifiedDataForms
```
protected boolean checkModifiedDataForms
```
- visiblePermission
```
protected FMPermission visiblePermission
```
- id
```
protected String id
```
  A String with the identifier of this FormManager
- ruleEngine
```
protected RuleEngine ruleEngine
```
  Since:
  
  5.2075EN
- application
```
protected Application application
```
  Application reference
- formRegisteredDataNavigationListener
```
protected Vector formRegisteredDataNavigationListener
```
  A list formed by the forms where this FormManager has been registered as a DataNavigationListener in.
- processDataChangeEvents
```
protected boolean processDataChangeEvents
```
  The FormManager will dispatch the DataNavigationEvent if this is true
- aPreferences
```
protected ApplicationPreferences aPreferences
```
  The ApplicationPreferences reference
- preferenceListenersRegistered
```
protected boolean preferenceListenersRegistered
```
  Condition used to register the preference listener only one time
- dynamicFormClass
```
protected String dynamicFormClass
```
- formDynamicManager
```
protected DynamicFormManager formDynamicManager
```
- loadedForm
```
protected boolean loadedForm
```
  If this condition is true, the FormManager will be loaded.
- initialForm
```
protected String initialForm
```
  The Form name that will be shown at first
- rules
```
protected String rules
```
  The complete path for rule file for initial form. E.g. 'com/ontimize/client/modules/rules.orl'
- initialInteractionManager
```
protected InteractionManager initialInteractionManager
```
  The InteractionManager reference of the form that will be shown at first
- setResourceBundleOnLoad
```
protected boolean setResourceBundleOnLoad
```
- delayedLoad
```
protected boolean delayedLoad
```
  If this condition is setted to true,this FormManager will not be loaded when is instanced, that is, the initial Form class, InteractionManager class, and Tree class will not be instanced until the FormManager is called for first time. The condition value is established with the IFormManager.DELAYED_LOAD attribute,by default is false.
  
  See Also:
  #FormManager(Hashtable)}
- defaultInteractionManagerLoader
```
public static String defaultInteractionManagerLoader
```
- interactionManagerLoader
```
protected String interactionManagerLoader
```
- iManagerLoader
```
protected InteractionManagerLoader iManagerLoader
```
- ruleEngineLoader
```
protected RuleEngineLoader ruleEngineLoader
```
- formModifiableFields
```
protected Hashtable formModifiableFields
```
- showFrame
```
protected boolean showFrame
```
- icon
```
protected String icon
```
- restricted
```
protected boolean restricted
```
- formManagerForms
```
protected Hashtable formManagerForms
```

Constructor Detail

BaseFormManager

public BaseFormManager(Hashtable parameters)
                throws Exception

Creates a FormManager instance with the parameters establishes in Hastable. This constructor is called from ApplicationBuilder

The parameters Hashtable contains the attribute values set in the Application XML.

attribute	values	default	required	meaning
id			yes	Establishes the unique identifier for this `FormManager`
useclasspath	yes/no	no	no	Establishes if the form files are loaded using a location relative to the classpath.
locator			no	A `EntityReferenceLocator` reference.
application			no	An `Application` reference.
formbuilder			yes	A `FormBuilder` reference.
treebuilder			yes	A `TreeBuilder` reference.
tree			no	Established the path of tree xml description file.
treeclass			no	Established the class name that will be instanced for create a `Tree`
frame			yes	Established the application `Frame` reference.
container			yes	Established container where this `FormManager` will be layered out in.
form			yes	Established the initial `Form` that will be loaded at first.
imanager			no	Established the `InteractionManager` that will be registered to initial `Form`
imloader			no	Established the `InteractionManagerLoader` that will be registered
resources			no	Established the `ResourceBundle` that will be used in this `FormManager`
dynamicform			no	Established the `DynamicFormManager` class name that will be used.
delayedload	yes/no/background	no	no	Established the `delayedLoad` condition.


Throws:
Exception







BaseFormManager
public BaseFormManager(Frame frame,
               Container container,
               FormBuilder builder,
               String formURI,
               ResourceBundle resource,
               boolean northPanel)
Builds a FormManager
Parameters:
frame - the Application Frame
container - Container where is layered out the
            FormManagerin.
builder - FormBuilder used to create the Form
            instances.
formURI - URI where is stored the xml description in.
resource - ResourceBundle where is the language resources in.
northPanel - true if new components can be added in
            FormManager using the addTopComponent(java.awt.Component)
            method.







BaseFormManager
public BaseFormManager(Frame frame,
               Container container,
               FormBuilder builder,
               String formURI,
               InteractionManager interactionManager,
               ResourceBundle resource,
               boolean northPanel)
Builds a FormManager
Parameters:
frame - the Application Frame
container - Container where is layered out the
            FormManagerin.
builder - FormBuilder used to create the Form
            instances.
formURI - URI where is stored the xml description in.
interactionManager - InteractionManager reference.
resource - ResourceBundle where is the language resources in.
northPanel - true if new components can be added in
            FormManager using the addTopComponent(java.awt.Component)
            method.







BaseFormManager
public BaseFormManager(Frame frame,
               Container container,
               FormBuilder builder,
               String formURI,
               ResourceBundle resource)
Builds a FormManager
Parameters:
frame - the Application Frame
container - Container where is layered out the
            FormManagerin.
builder - FormBuilder used to create the Form
            instances.
formURI - URI where is stored the xml description in.
resource - ResourceBundle where is the language resources in.







Method Detail





init
public void init(Hashtable parameters)
          throws Exception
Throws:
Exception







load
public void load()
Loads the FormManager.The initial Form, initial
 InteractionManager and Tree are instanced and
 are layered out in container to be shown. All this operations are
 performed in EventDispatchThread.

Specified by:
load in interface IFormManager








loadInEDTh
public void loadInEDTh()
Loads the FormManager. This method must be called from
 EventDispatchThread.

Specified by:
loadInEDTh in interface IFormManager
See Also:
load()







createCenterPanel
protected abstract JComponent createCenterPanel()







createLayout
protected void createLayout(Frame frame,
                Container container,
                FormBuilder builder,
                String formURI,
                InteractionManager interactionManager,
                ResourceBundle resource,
                boolean northPanel)







loadForms
public void loadForms(List<String> formList)
Loads the form list from Vector instance that are passed as
 entry parameter. For each form from Vector, this method will
 call the IFormManager#loadFormInEDTh method.
Parameters:
formList - List of Form to be loaded







configureRules
protected void configureRules(String formFileName)







showForm
public boolean showForm(String formName)
Description copied from interface: IFormManager
Shows the form which file name is passed as entry parameter If this form
 isn't loaded, this method will load the form. Before the form will be
 shown, this method checks if the current form has modified data. This
 method call the IFormManager.showFormInEDTh(java.lang.String) from EventDispatchThread.

Specified by:
showForm in interface IFormManager
Parameters:
formName - a String with the file name.
Returns:
true if the form is showed.







loadForm
protected void loadForm(String fileName)







addFormToContainer
public abstract void addFormToContainer(JPanel panelForm,
                      String formName)

Specified by:
addFormToContainer in interface IFormManager








loadFormInEDTh
protected void loadFormInEDTh(String formFileName)
Loads the Form which file name is passed as entry parameter. If the Form
 has just been loaded before this method does nothing. 

 First, this method checks whether a form reference exists remotely using
 the XMLFormProvider. If this remote reference doesn't exist
Parameters:
formFileName - 







getFormReference
public Form getFormReference(String formName,
                    boolean loadIfNecessary)
Gets the form reference which name is passed as entry parameter. This
 method call the load() if is necessary and the loadIfNecessary
 parameter is true.

Specified by:
getFormReference in interface IFormManager
Parameters:
formName - a Form name.
loadIfNecessary - true to be loaded the FormManager







getFormReference
public Form getFormReference(String form)
Gets a Form reference which name is passed as entry
 parameter.

Specified by:
getFormReference in interface IFormManager
Returns:
a Form reference; null if the Form hasn't been
         loaded.







getFormCopy
public Form getFormCopy(String formName)
Gets a Form instance copy which form name is passed as entry
 parameter.

Specified by:
getFormCopy in interface IFormManager
Parameters:
formName - a String with the Form name.







getFormCopyWithoutInteractionManager
public Form getFormCopyWithoutInteractionManager(String formName)
Gets a Form instance copy which form name is passed as entry
 parameter. The Form reference that will be returned doesn't
 have registered any InteractionManager
Parameters:
formName - a String with the Form name.
Returns:
a Form reference







getFormCopyWithoutInteractionManager
public Form getFormCopyWithoutInteractionManager(String formName,
                                        Container container)
Gets a Form instance copy which form name is passed as entry
 parameter. This Form copy is layered out into the container
 parameter. The Form reference that will be returned doesn't
 have registered any InteractionManager. This method call the
 getFormCopyWithoutInteractionManagerInEDTh(java.lang.String, java.awt.Container) method from
 EventDispatchThread.
Parameters:
formName - a String with the Form name.
container - a Container where the Form will be
            displayed in.
Returns:
a Form reference.







getFormCopyWithoutInteractionManagerInEDTh
public Form getFormCopyWithoutInteractionManagerInEDTh(String formName,
                                              Container container)
Gets a Form instance copy which form name is passed as entry
 parameter. This Form copy is layered out into the container
 parameter. The Form reference that will be returned doesn't
 have registered any InteractionManager.
Parameters:
formName - a String with the Form name.
container - a Container where the Form will be
            displayed in.
Returns:
a Form reference.







getFormCopy
public Form getFormCopy(String formName,
               Container container)
Description copied from interface: IFormManager
Gets a Form instance copy which form name is passed as entry
 parameter. This Form copy is layered out into the container
 parameter. The Form reference that will be returned have
 registered the InteractionManager that has been defined in
 application xml description. This method calls the
 IFormManager.getFormCopyInEDTh(java.lang.String) method from EventDispatchThread.

Specified by:
getFormCopy in interface IFormManager
Parameters:
formName - a String with the Form name.
container - a Container where the Form will be
            displayed in.
Returns:
a Form reference.







getFormCopy
public Form getFormCopy(String formResourceName,
               String imQualifiedName)
Gets a Form instance copy which form resource name is passed
 as entry parameter. This Form copy is layered out into the
 container parameter. The Form reference that will be
 returned have registered the InteractionManager that has
 been passed as entry parameter. This method calls the
 getFormCopyInEDTh(java.lang.String, java.lang.String) method from EventDispatchThread.

Specified by:
getFormCopy in interface IFormManager
Parameters:
formResourceName - a String with the Form name.
imQualifiedName - a String with the interaction manager qualified
            class name.
Returns:
a Form reference.







getURL
public URL getURL(String formName)
Gets the Form URL which name is passed as entry parameter. The base
 classpath is retrieved from baseCP variable.

Specified by:
getURL in interface IFormManager
Parameters:
formName - a String with the Form file name.

Returns:
a URL reference








getFormCopyInEDTh
protected Form getFormCopyInEDTh(String formResourceName,
                     String imQualifiedName)
Gets a Form instance copy which form resource name is passed
 as entry parameter. This Form copy is layered out into the
 container parameter. The Form reference that will be
 returned have registered the InteractionManager that has
 been passed as entry parameter. This method calls the
 getFormCopyInEDTh(java.lang.String, java.lang.String) method from EventDispatchThread.
Parameters:
formResourceName - a String with the Form name.
imQualifiedName - a String with the interaction manager qualified
            class name.
Returns:
a Form reference.







getFormCopyInEDTh
public Form getFormCopyInEDTh(String formName)

Specified by:
getFormCopyInEDTh in interface IFormManager








getFormCopyInEDTh
protected Form getFormCopyInEDTh(String formName,
                     Container container)
Gets a Form instance copy which form name is passed as entry
 parameter. This Form copy is layered out into the container
 parameter. The Form reference that will be returned have
 registered the InteractionManager that has been defined in
 application xml description.
Parameters:
formName - a String with the Form name.
container - a Container where the Form will be
            displayed in.
Returns:
a Form reference.







getReferenceLocator
public EntityReferenceLocator getReferenceLocator()
Gets the EntityReferenceLocator reference that is stored
 inside.

Specified by:
getReferenceLocator in interface IFormManager
Returns:
a EntityReferenceLocator







setReferenceLocator
public void setReferenceLocator(EntityReferenceLocator locator)
Sets the EntityReferenceLocator reference used in this
 FormManager

Specified by:
setReferenceLocator in interface IFormManager
Parameters:
locator - 







getTextsToTranslate
public Vector getTextsToTranslate()
Description copied from interface: Internationalization
Returns all the texts in the element suitable for being translated.

Specified by:
getTextsToTranslate in interface Internationalization
Returns:
all the texts in the element suitable for being translated.







saveTextsToTranslate
public void saveTextsToTranslate(String file,
                        boolean append,
                        Vector keys,
                        Properties importProp)
Stores in the file which name is passed as entry parameters all texts in
 the FormManager that must be translated.
Parameters:
file - the destiny file
append - boolean if true, then the translate text will be
            will be written to the end of the file rather than the
            beginning.
keys - Vector with the keys that has just been added.
importProp - 







setResourceBundle
public void setResourceBundle(ResourceBundle resources)
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
Parameters:
resources - the new language bundle.







setResourceBundle_internal
protected void setResourceBundle_internal()







showCurrencyValue
public void showCurrencyValue(String currencySymbol)

Specified by:
showCurrencyValue in interface SelectCurrencyValues








setComponentLocale
public void setComponentLocale(Locale l)

Specified by:
setComponentLocale in interface Internationalization








setInteractionManager
public void setInteractionManager(InteractionManager interactionManager,
                         String formName)
Registers the InteractionManager which is passed as entry
 parameter to the Form which name is passed as entry parameter as well. If
 the Form has just been loaded, the InteractionManager is
 registered else the Form name and the InteractionManager
 instance are stored in interactionManagerList variable to be
 registered when the Form is loaded.

Specified by:
setInteractionManager in interface IFormManager
Parameters:
interactionManager - InteractionManager reference where the
            Form is registered in.
formName - a String with the Form file name.







getInteractionManager
public InteractionManager getInteractionManager(String formName)

Specified by:
getInteractionManager in interface IFormManager








setInteractionManager
public void setInteractionManager(String interactionManagerClass,
                         String formName)
Sets the InteractionManager for a
 Form which file name is passed as entry parameter.
 The InteractionManager instance is loaded by reflection and
 the class constructor mustn't have any parameter.


Specified by:
setInteractionManager in interface IFormManager
Parameters:
interactionManagerClass - String with the InteractionManager Class name.
formName - String with the Form file name.







applyInteractionManager
protected void applyInteractionManager(String interactionManagerClass,
                           String formName)
Creates the InteractionManager class instance and call the
 setInteractionManager(InteractionManager, String)
Parameters:
interactionManagerClass - a String with the InteractionManager
            class name.
formName - a String with the Form file name.







getCurrentForm
public String getCurrentForm()
Gets the Form name that is currently visible.







free
public void free()
          throws Exception
Description copied from interface: Freeable
Makes the object to release the resources.

Specified by:
free in interface Freeable
Throws:
Exception







finalize
protected void finalize()
                 throws Throwable

Overrides:
finalize in class Object
Throws:
Throwable







getResourceBundle
public ResourceBundle getResourceBundle()
Gets the ResourceBundle reference stored in this
 FormManager

Specified by:
getResourceBundle in interface IFormManager
Returns:
a ResourceBundle reference







getResourceFileName
public String getResourceFileName()
Description copied from interface: IFormManager
Gets the ResourceBundle name stored in this
 FormManager

Specified by:
getResourceFileName in interface IFormManager
Returns:
a String reference







showAvaliableFonts
public Font showAvaliableFonts(boolean supportingEuro)
Description copied from interface: FontAndEncodingSelector
Shows the available fonts in the system. The parameter specifies if only
 fonts with support for EURO character must be showed

Specified by:
showAvaliableFonts in interface FontAndEncodingSelector








supportsEuroSymbol
public static boolean supportsEuroSymbol(Font font)
Checks if the euro symbol can be displayed by the Font that
 is passed as entry parameter.
Parameters:
font - a Font that must display the euro symbol.
Returns:
true if euro symbol can be displayed.







useFont
public void useFont(Font f)
Description copied from interface: FontAndEncodingSelector
Set the font to use by the object

Specified by:
useFont in interface FontAndEncodingSelector








getContainer
public Container getContainer()
Gets the container where the FormManager is layered out in.

Specified by:
getContainer in interface IFormManager
Returns:
a Container reference.







addTopComponent
public void addTopComponent(Component component)
Adds the component that is passed as entry parameter to
 IFormManager#panelTop
Parameters:
component - 







setId
public void setId(String id)
Sets the unique identifier for this FormManager
Parameters:
id - a String with the unique identifier.







getId
public String getId()
Gets the unique identifier for this FormManager

Specified by:
getId in interface IFormManager
Returns:
a String with the unique identifier.







initPermissions
public void initPermissions()

Specified by:
initPermissions in interface SecureElement








setApplication
public void setApplication(Application application)
Sets the Application reference.

Specified by:
setApplication in interface IFormManager
Parameters:
application - 







getApplication
public Application getApplication()
Gets the Application reference.

Specified by:
getApplication in interface IFormManager
Returns:
a Application reference







checkVisiblePermission
protected boolean checkVisiblePermission(String id)
Checks if this FormManager is restricted with visible
 permissions
Parameters:
id - 
Returns:
false







getAttributeValue
protected Object getAttributeValue(Object attribute,
                       OTreeNode node)
Gets the attribute value into the OTreeNode that is passed
 as entry parameter. This method search this attribute into the
 OTreeNode and its parents.
Parameters:
attribute - the attribute to be found.
node - OTreeNode where the search of the attribute value
            will start in.
Returns:
a attribute value.







setCheckModifiedFormData
public void setCheckModifiedFormData(boolean check)
Enables/disables the check of modified form data
Parameters:
check - true the check of modifed form data is enabled.







getLabelFileURI
public String getLabelFileURI()

Specified by:
getLabelFileURI in interface IFormManager








setActiveForm
public void setActiveForm(Form f)

Specified by:
setActiveForm in interface IFormManager








getActiveForm
public Form getActiveForm()
Returns the active Form reference. This method takes into
 account both the forms displayed in container and the forms layered out
 in DetailForms. Returns the Form reference
 established in method setActiveForm(Form). If the
 Form reference hasn't been established then this method
 returns the Form reference that is visible into the
 FormManager container.

Specified by:
getActiveForm in interface IFormManager
Returns:








dataWillChange
public boolean dataWillChange(DataNavigationEvent e)
Description copied from interface: DataNavigationListener
Called when a form is going to change the status. In order to allow the
 change, this method must return true.

Specified by:
dataWillChange in interface DataNavigationListener
Returns:
true if the change can be done; false otherwise







dataChanged
public void dataChanged(DataNavigationEvent e)
Description copied from interface: DataNavigationListener
Notifies that the data in the form has changed.

Specified by:
dataChanged in interface DataNavigationListener








setApplicationPreferences
public void setApplicationPreferences(ApplicationPreferences ap)

Specified by:
setApplicationPreferences in interface IFormManager








updateInteractionDynamicFormMode
protected void updateInteractionDynamicFormMode(Form form)







reload
public void reload(Form form)
Reload the Form that is passed as entry parameter.

Specified by:
reload in interface IFormManager
Parameters:
form - Form reference to be reloaded.







isRestricted
public boolean isRestricted()

Specified by:
isRestricted in interface SecureElement








getDelayedLoad
public boolean getDelayedLoad()
Gets the delayed load condition
Returns:
true if the FormManager will delay its loaded.







setFormManagerToForm
public void setFormManagerToForm(String formName,
                        String formManagerId)
Stores in the formManagerForms variable the
 FormManager unique identifier and the Form name
 that are passed as entry parameter.
Parameters:
formName - String with the form name.
formManagerId - String with the unique identifier where is stored
            the Form in.







isLoaded
public boolean isLoaded()

Specified by:
isLoaded in interface IFormManager








setUpdateMode
protected void setUpdateMode(Form form)







setQueryInsertMode
protected void setQueryInsertMode(Form form)







getFormBuilder
public FormBuilder getFormBuilder()

Specified by:
getFormBuilder in interface IFormManager








getRuleEngine
public RuleEngine getRuleEngine()

Specified by:
getRuleEngine in interface IFormManager








setRuleEngine
public void setRuleEngine(RuleEngine ruleEngine)







showFrame
public boolean showFrame()
Description copied from interface: IFormManager
Determines whether this FormManager should be shown in a new Frame.

Specified by:
showFrame in interface IFormManager
Returns:
true if is shown in a new Frame







getIcon
public String getIcon()
Description copied from interface: IFormManager
Determines the icon that should be shown in a new Frame

Specified by:
getIcon in interface IFormManager
Returns:

Class BaseFormManager

Nested Class Summary

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

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface com.ontimize.gui.manager.IFormManager

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

Fields inherited from interface com.ontimize.gui.SecureElement

Fields inherited from interface com.ontimize.gui.SelectCurrencyValues

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface com.ontimize.gui.manager.IFormManager

Field Detail

M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE

M_MODIFIED_DATA

applicationFrame

panelTop

parent

loadedList

locale

formReferenceList

uRIBase

useClasspath

baseCP

locator

interactionManagerList

formInteractionManagerClassNameList

formInteractionManagerActionList

formRules

currentForm

resourceFileName

resourceFile

formBuilder

auxPanel

interactionManagers

checkModifiedDataForms

visiblePermission

id

ruleEngine

application

formRegisteredDataNavigationListener

processDataChangeEvents

aPreferences

preferenceListenersRegistered

dynamicFormClass

formDynamicManager

loadedForm

initialForm

rules

initialInteractionManager

setResourceBundleOnLoad

delayedLoad

defaultInteractionManagerLoader

interactionManagerLoader

iManagerLoader

ruleEngineLoader

formModifiableFields

showFrame

icon

restricted

formManagerForms

Constructor Detail

BaseFormManager

BaseFormManager

BaseFormManager

BaseFormManager

Method Detail

init

load

loadInEDTh