Ontimize 5.2072EN

com.ontimize.gui
Class FormManager

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycom.ontimize.gui.FormManager
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, DataNavigationListener, java.util.EventListener, FontAndEncodingSelector, Freeable, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, SelectCurrencyValues, java.io.Serializable, javax.swing.event.TreeExpansionListener, javax.swing.event.TreeSelectionListener, javax.swing.event.TreeWillExpandListener

public class FormManager
extends javax.swing.JPanel
implements javax.swing.event.TreeSelectionListener, javax.swing.event.TreeWillExpandListener, javax.swing.event.TreeExpansionListener, Internationalization, java.awt.event.ActionListener, Freeable, SelectCurrencyValues, FontAndEncodingSelector, SecureElement, DataNavigationListener

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 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
static java.lang.String ACTION
          XML Attribute
protected  Application application
          Application reference
static java.lang.String APPLICATION
          XML Attribute
protected  java.awt.Frame applicationFrame
          Application frame reference.
protected  ApplicationPreferences aPreferences
          The ApplicationPreferences reference
static java.lang.String CONTAINER
          XML Attribute
protected  java.lang.String currentForm
          The form name that is visible in this FormManager
static java.lang.String defaultInteractionManagerLoader
           
static java.lang.String defaultTreeClass
          The default Tree class name
static java.lang.String DELAYED_LOAD
          XML Attribute
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.
static java.lang.String DETAIL
           
static java.lang.String DYNAMIC_FORM
          XML Attribute
protected  java.lang.String dynamicFormClass
           
static java.lang.String FORM
          XML Attribute
static java.lang.String FORM_BUILDER
          XML Attribute
protected  FormBuilder formBuilder
          FormBuilder reference
protected  DynamicFormManager formDynamicManager
           
protected  java.util.Hashtable formInteractionManagerActionList
          A Hashtable with the interaction manager class name assigned to each action handler.
protected  java.util.Hashtable formInteractionManagerClassNameList
          A Hashtable with the interaction manager class name assigned to each form.
protected  java.awt.CardLayout formLayout
          CardLayout reference used to lay out the forms.
protected  java.util.Hashtable formManagerForms
           
protected  java.util.Hashtable formModifiableFields
           
protected  javax.swing.JPanel formPanel
          JPanel reference where the form is layered out in.
protected  java.util.Hashtable formReferenceList
          A Hashtable with a form list where the key is the form name and the value a Form class instance.
protected  java.util.Vector formRegisteredDataNavigationListener
          A list formed by the forms where this FormManager has been registered as a DataNavigationListener in.
static java.lang.String FRAME
          XML Attribute
protected  java.lang.String id
          A String with the identifier of this FormManager
static java.lang.String ID
          XML Attribute
static java.lang.String IM_LOADER
          XML Attribute
protected  InteractionManagerLoader iManagerLoader
           
protected  java.lang.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
static java.lang.String INTERACTION_MANAGER
          XML Attribute
protected  java.util.Hashtable interactionManagerList
          A Hashtable with the interaction manager to be registered.
protected  java.lang.String interactionManagerLoader
           
protected static java.lang.String LOAD
          XML Attribute
protected  boolean loadedTreeAndForm
          If this condition is true, the FormManager will be loaded.
static java.lang.String LOCATOR
          XML Attribute
static java.lang.String M_MODIFIED_DATA
          GUI Text
static java.lang.String M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE
          GUI Text
protected  Tree managedTree
          The Tree reference that will be displayed in this FormManager
static java.lang.String METAL
           
static java.lang.String MOTIF
           
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  java.util.ResourceBundle resourceFile
          ResourceBundle reference
protected  java.lang.String resourceFileName
          ResourceBundle file name
static java.lang.String RESOURCES
          XML Attribute
protected  boolean restricted
           
protected  boolean setResourceBundleOnLoad
           
protected  javax.swing.JSplitPane splitPane
          SplitPane reference used when a Tree is defined.
static java.lang.String SYSTEM
           
static java.lang.String TREE
          XML Attribute
static java.lang.String TREE_BUILDER
          XML Attribute
static java.lang.String TREE_CLASS
          XML Attribute
protected  TreeBuilder treeBuilder
          TreeBuilder reference.
protected  java.lang.String treeClass
          The Tree class name established for this FormManager.
protected  java.lang.String treeFileName
          The file name of the tree xml description.
protected  javax.swing.JScrollPane treeScrollPane
          JScrollPane reference.
static java.lang.String USE_CLASS_PATH
          XML Attribute
 
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.i18n.Internationalization
DEBUG_LANGUAGE
 
Fields inherited from interface com.ontimize.gui.SelectCurrencyValues
EURO, PST
 
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
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, InteractionManager interactionManager, java.util.ResourceBundle resource)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, InteractionManager interactionManager, java.util.ResourceBundle resource, boolean northPanel)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, InteractionManager interactionManager, java.util.ResourceBundle resource, Tree tree)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, InteractionManager interactionManager, java.util.ResourceBundle resource, Tree tree, boolean northPanel)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, java.util.ResourceBundle resource)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, java.util.ResourceBundle resource, boolean northPanel)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, java.util.ResourceBundle resource, Tree tree)
          Builds a FormManager
FormManager(java.awt.Frame frame, java.awt.Container container, FormBuilder builder, java.lang.String formURI, java.util.ResourceBundle resource, Tree tree, boolean northPanel)
          Builds a FormManager
FormManager(java.util.Hashtable parameters)
          Creates a FormManager instance with the parameters establishes in Hastable.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
           
 void addTopComponent(java.awt.Component component)
          Adds the component that is passed as entry parameter to FormManager#panelTop
protected  void applyInteractionManager(java.lang.String interactionManagerClass, java.lang.String formName)
          Creates the InteractionManager class instance and call the setInteractionManager(InteractionManager, String)
protected  boolean checkVisiblePermission(java.lang.String id)
          Checks if this FormManager is restricted with visible permissions
 void dataChanged(DataNavigationEvent e)
          Notifies that the data in the form has changed.
 void dataInserted()
          This method does that the parent node of current selected node will be selected if the current selected node is a data node.
 void dataInserted(java.util.Hashtable keysValues)
          Deprecated.  
 boolean dataWillChange(DataNavigationEvent e)
          Called when a form is going to change the status.
 void deletedNode(javax.swing.tree.TreePath path, java.util.Hashtable keysValues, boolean select)
          This method calls the deletedNode method of the Tree associated to this FormManager
protected  void finalize()
           
 void first()
          Flips to the first Form that is stored in the FormManager
protected  void fitSpaceToTree()
          Fits the space to the tree.
 void free()
          Makes the object to release the resources.
 Form getActiveForm()
          Returns the active Form reference.
 Application getApplication()
          Gets the Application reference.
protected  java.lang.Object getAttributeValue(java.lang.Object attribute, OTreeNode node)
          Gets the attribute value into the OTreeNode that is passed as entry parameter.
 java.awt.Container getContainer()
          Gets the container where the FormManager is layered out in.
 java.lang.String getCurrentForm()
          Gets the Form name that is currently visible.
 boolean getDelayedLoad()
          Gets the delayed load condition
 FormBuilder getFormBuilder()
           
 Form getFormCopy(java.lang.String formName)
          Gets a Form instance copy which form name is passed as entry parameter.
 Form getFormCopy(java.lang.String formName, java.awt.Container container)
           
 Form getFormCopy(java.lang.String formResourceName, java.lang.String imQualifiedName)
          Gets a Form instance copy which form resource name is passed as entry parameter.
 Form getFormCopyInEDTh(java.lang.String formName)
           
protected  Form getFormCopyInEDTh(java.lang.String formName, java.awt.Container container)
          Gets a Form instance copy which form name is passed as entry parameter.
protected  Form getFormCopyInEDTh(java.lang.String formResourceName, java.lang.String imQualifiedName)
          Gets a Form instance copy which form resource name is passed as entry parameter.
 Form getFormCopyWithoutInteractionManager(java.lang.String formName)
          Gets a Form instance copy which form name is passed as entry parameter.
 Form getFormCopyWithoutInteractionManager(java.lang.String formName, java.awt.Container container)
          Gets a Form instance copy which form name is passed as entry parameter.
 Form getFormCopyWithoutInteractionManagerInEDTh(java.lang.String formName, java.awt.Container container)
          Gets a Form instance copy which form name is passed as entry parameter.
 Form getFormReference(java.lang.String form)
          Gets a Form reference which name is passed as entry parameter.
 Form getFormReference(java.lang.String formName, boolean loadIfNecessary)
          Gets the form reference which name is passed as entry parameter.
 java.lang.String getId()
          Gets the unique identifier for this FormManager
 javax.swing.JSplitPane getJSPlitPane()
          Gets the JSplitPane reference.
 java.lang.String getLabelFileURI()
           
 EntityReferenceLocator getReferenceLocator()
          Gets the EntityReferenceLocator reference that is stored inside.
 java.util.ResourceBundle getResourceBundle()
          Gets the ResourceBundle reference stored in this FormManager
 java.lang.String getResourceFileName()
           
 java.util.Vector getTextsToTranslate()
          Returns all the texts in the element suitable for being translated.
 Tree getTree()
          Gets the Tree reference that is associated to this FormManager
 java.net.URL getURL(java.lang.String formName)
          Gets the Form URL which name is passed as entry parameter.
 void initPermissions()
           
 void insertedNode(javax.swing.tree.TreePath path, java.util.Hashtable keysValues)
          Inserts a new node into the Tree associated to this FormManager
 void insertedNode(javax.swing.tree.TreePath path, java.util.Hashtable keysValues, boolean childSelect)
          This method call the insertedNode(TreePath, Hashtable) and the new node will be selected if the condition childSelect is true.
 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(java.lang.String fileName)
           
protected  void loadFormInEDTh(java.lang.String formFileName)
          Loads the Form which file name is passed as entry parameter.
 void loadForms(java.util.Vector formList)
          Loads the form list from Vector instance that are passed as entry parameter.
protected  void loadInEDTh()
          Loads the FormManager.
 void next()
          Flips to the next Form that is stored in the FormManager
protected  void registerApplicationPreferencesListener()
           
protected  void reload(Form form)
          Reload the Form that is passed as entry parameter.
 void saveTextsToTranslate(java.lang.String file, boolean append, java.util.Vector keys, java.util.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 setCheckModified(boolean enabled)
           
 void setCheckModifiedFormData(boolean check)
          Enables/disables the check of modified form data
 void setComponentLocale(java.util.Locale l)
           
 void setFormManagerToForm(java.lang.String formName, java.lang.String formManagerId)
          Stores in the formManagerForms variable the FormManager unique identifier and the Form name that are passed as entry parameter.
 void setId(java.lang.String id)
          Sets the unique identifier for this FormManager
 void setInteractionManager(InteractionManager interactionManager, java.lang.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(java.lang.String interactionManagerClass, java.lang.String formName)
          Sets the InteractionManager for a Form which file name is passed as entry parameter.
protected  void setLookAndFeel(java.lang.String look)
           
 void setProcessingTreeSelectionEvent(boolean process)
          Enables/disables the dispatcher the tree selection event.
 void setReferenceLocator(EntityReferenceLocator locator)
          Sets the EntityReferenceLocator reference used in this FormManager
 void setResourceBundle(java.util.ResourceBundle resources)
          Sets the language resource bundle.
 java.awt.Font showAvaliableFonts(boolean supportingEuro)
          Shows the available fonts in the system.
 void showCurrencyValue(int idCurrency)
           
 boolean showForm(java.lang.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.
protected  boolean showFormInEDTh(java.lang.String form)
          Shows the form which file name is passed as entry parameter
static boolean supportsEuroSymbol(java.awt.Font font)
          Checks if the euro symbol can be displayed by the Font that is passed as entry parameter.
 void treeCollapsed(javax.swing.event.TreeExpansionEvent event)
           
 void treeExpanded(javax.swing.event.TreeExpansionEvent event)
           
 void treeWillCollapse(javax.swing.event.TreeExpansionEvent event)
           
 void treeWillExpand(javax.swing.event.TreeExpansionEvent event)
           
 void updatedNode(javax.swing.tree.TreePath path, java.util.Hashtable attributesValues, java.util.Hashtable keysValues)
          Updates the node of the Tree associate to this FormManager.
 void updatedNode(javax.swing.tree.TreePath path, java.util.Hashtable attributesValues, java.util.Hashtable keysValues, boolean select)
          Updates the node of the Tree associate to this FormManager.
protected  void updateInteractionDynamicFormMode(Form form)
           
 void updateParentkeys(OTreeNode node)
           
 void useFont(java.awt.Font f)
          Set the font to use by the object
 void valueChanged(javax.swing.event.TreeSelectionEvent event)
           
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
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, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, 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, removePropertyChangeListener, removePropertyChangeListener, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TREE_CLASS

public static final java.lang.String TREE_CLASS
XML Attribute

See Also:
Constant Field Values

TREE_BUILDER

public static final java.lang.String TREE_BUILDER
XML Attribute

See Also:
Constant Field Values

FORM_BUILDER

public static final java.lang.String FORM_BUILDER
XML Attribute

See Also:
Constant Field Values

FRAME

public static final java.lang.String FRAME
XML Attribute

See Also:
Constant Field Values

CONTAINER

public static final java.lang.String CONTAINER
XML Attribute

See Also:
Constant Field Values

USE_CLASS_PATH

public static final java.lang.String USE_CLASS_PATH
XML Attribute

See Also:
Constant Field Values

APPLICATION

public static final java.lang.String APPLICATION
XML Attribute

See Also:
Constant Field Values

LOCATOR

public static final java.lang.String LOCATOR
XML Attribute

See Also:
Constant Field Values

DETAIL

public static final java.lang.String DETAIL
See Also:
Constant Field Values

IM_LOADER

public static final java.lang.String IM_LOADER
XML Attribute

See Also:
Constant Field Values

DELAYED_LOAD

public static final java.lang.String DELAYED_LOAD
XML Attribute

See Also:
Constant Field Values

DYNAMIC_FORM

public static final java.lang.String DYNAMIC_FORM
XML Attribute

See Also:
Constant Field Values

RESOURCES

public static final java.lang.String RESOURCES
XML Attribute

See Also:
Constant Field Values

INTERACTION_MANAGER

public static final java.lang.String INTERACTION_MANAGER
XML Attribute

See Also:
Constant Field Values

FORM

public static final java.lang.String FORM
XML Attribute

See Also:
Constant Field Values

ACTION

public static final java.lang.String ACTION
XML Attribute

See Also:
Constant Field Values

TREE

public static final java.lang.String TREE
XML Attribute

See Also:
Constant Field Values

LOAD

protected static final java.lang.String LOAD
XML Attribute

See Also:
Constant Field Values

ID

public static final java.lang.String ID
XML Attribute

See Also:
Constant Field Values

METAL

public static final java.lang.String METAL
See Also:
Constant Field Values

SYSTEM

public static final java.lang.String SYSTEM
See Also:
Constant Field Values

MOTIF

public static final java.lang.String MOTIF
See Also:
Constant Field Values

M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE

public static java.lang.String M_NOT_DATA_IT_IS_POSSIBLE_THAT_RECORD_HAS_BEEN_DELETE
GUI Text


M_MODIFIED_DATA

public static java.lang.String M_MODIFIED_DATA
GUI Text


applicationFrame

protected java.awt.Frame applicationFrame
Application frame reference.


formReferenceList

protected java.util.Hashtable formReferenceList
A Hashtable with a form list where the key is the form name and the value a Form class instance.


interactionManagerList

protected java.util.Hashtable 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 java.util.Hashtable 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 java.util.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

formLayout

protected java.awt.CardLayout formLayout
CardLayout reference used to lay out the forms.


splitPane

protected javax.swing.JSplitPane splitPane
SplitPane reference used when a Tree is defined. If the FormManager hasn't defined a tree, this reference is null.


treeScrollPane

protected javax.swing.JScrollPane treeScrollPane
JScrollPane reference. Only if the tree is defined, this reference will have a value.


formPanel

protected javax.swing.JPanel formPanel
JPanel reference where the form is layered out in. The layout of this panel is stored in the formLayout variable


managedTree

protected Tree managedTree
The Tree reference that will be displayed in this FormManager


currentForm

protected java.lang.String currentForm
The form name that is visible in this FormManager


resourceFileName

protected java.lang.String resourceFileName
ResourceBundle file name


resourceFile

protected java.util.ResourceBundle resourceFile
ResourceBundle reference


formBuilder

protected FormBuilder formBuilder
FormBuilder reference


treeBuilder

protected TreeBuilder treeBuilder
TreeBuilder reference.


id

protected java.lang.String id
A String with the identifier of this FormManager


application

protected Application application
Application reference


formRegisteredDataNavigationListener

protected java.util.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 java.lang.String dynamicFormClass

formDynamicManager

protected DynamicFormManager formDynamicManager

loadedTreeAndForm

protected boolean loadedTreeAndForm
If this condition is true, the FormManager will be loaded.


treeFileName

protected java.lang.String treeFileName
The file name of the tree xml description.


defaultTreeClass

public static java.lang.String defaultTreeClass
The default Tree class name


treeClass

protected java.lang.String treeClass
The Tree class name established for this FormManager. By default, if the TREE_CLASS attribute isn't established, has the defaultTreeClass value


initialForm

protected java.lang.String initialForm
The Form name that will be shown at first


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 DELAYED_LOAD attribute,by default is false.

See Also:
{@link #FormManager(Hashtable)}

defaultInteractionManagerLoader

public static java.lang.String defaultInteractionManagerLoader

interactionManagerLoader

protected java.lang.String interactionManagerLoader

iManagerLoader

protected InteractionManagerLoader iManagerLoader

formModifiableFields

protected java.util.Hashtable formModifiableFields

restricted

protected boolean restricted

formManagerForms

protected java.util.Hashtable formManagerForms
Constructor Detail

FormManager

public FormManager(java.util.Hashtable parameters)
            throws java.lang.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
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.


FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   java.util.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.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   java.util.ResourceBundle resource,
                   Tree tree,
                   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.
tree - Tree reference.
northPanel - true if new components can be added in FormManager using the addTopComponent(java.awt.Component) method.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   InteractionManager interactionManager,
                   java.util.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.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   InteractionManager interactionManager,
                   java.util.ResourceBundle resource,
                   Tree tree,
                   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.
tree - Tree reference.
northPanel - true if new components can be added in FormManager using the addTopComponent(java.awt.Component) method.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   java.util.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.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   java.util.ResourceBundle resource,
                   Tree tree)
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.
tree - Tree reference.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   InteractionManager interactionManager,
                   java.util.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.
interactionManager - InteractionManager reference.
resource - ResourceBundle where is the language resources in.

FormManager

public FormManager(java.awt.Frame frame,
                   java.awt.Container container,
                   FormBuilder builder,
                   java.lang.String formURI,
                   InteractionManager interactionManager,
                   java.util.ResourceBundle resource,
                   Tree tree)
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.
tree - Tree reference.
Method Detail

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.


loadInEDTh

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

See Also:
load()

loadForms

public void loadForms(java.util.Vector formList)
Loads the form list from Vector instance that are passed as entry parameter. For each form from Vector, this method will call the loadFormInEDTh(java.lang.String) method.

Parameters:
formList - List of Form to be loaded

loadForm

protected void loadForm(java.lang.String fileName)

loadFormInEDTh

protected void loadFormInEDTh(java.lang.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 -

showForm

public boolean showForm(java.lang.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. Before the form will be shown, this method checks if the current form has modified data. This method call the showFormInEDTh(java.lang.String) from EventDispatchThread.

Parameters:
formName - a String with the file name.
Returns:
true if the form is showed.

showFormInEDTh

protected boolean showFormInEDTh(java.lang.String form)
Shows the form which file name is passed as entry parameter

Parameters:
form -
Returns:
true if the form is showed.
See Also:
showForm(java.lang.String)

getFormReference

public Form getFormReference(java.lang.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.

Parameters:
formName - a Form name.
loadIfNecessary - true to be loaded the FormManager

getFormReference

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

Returns:
a Form reference; null if the Form hasn't been loaded.

getFormCopy

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

Parameters:
formName - a String with the Form name.

getFormCopyWithoutInteractionManager

public Form getFormCopyWithoutInteractionManager(java.lang.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(java.lang.String formName,
                                                 java.awt.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(java.lang.String formName,
                                                       java.awt.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(java.lang.String formName,
                        java.awt.Container container)

getFormCopy

public Form getFormCopy(java.lang.String formResourceName,
                        java.lang.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.

getURL

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

Parameters:
formName - a String with the Form file name.
Returns:
a URL reference

getFormCopyInEDTh

protected Form getFormCopyInEDTh(java.lang.String formResourceName,
                                 java.lang.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(java.lang.String formName)

getFormCopyInEDTh

protected Form getFormCopyInEDTh(java.lang.String formName,
                                 java.awt.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.

next

public void next()
Flips to the next Form that is stored in the FormManager


first

public void first()
Flips to the first Form that is stored in the FormManager


getReferenceLocator

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

Returns:
a EntityReferenceLocator

setReferenceLocator

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

Parameters:
locator -

getTextsToTranslate

public java.util.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(java.lang.String file,
                                 boolean append,
                                 java.util.Vector keys,
                                 java.util.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(java.util.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.

showCurrencyValue

public void showCurrencyValue(int idCurrency)
Specified by:
showCurrencyValue in interface SelectCurrencyValues

setComponentLocale

public void setComponentLocale(java.util.Locale l)
Specified by:
setComponentLocale in interface Internationalization

setInteractionManager

public void setInteractionManager(InteractionManager interactionManager,
                                  java.lang.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.

Parameters:
interactionManager - InteractionManager reference where the Form is registered in.
formName - a String with the Form file name.

setInteractionManager

public void setInteractionManager(java.lang.String interactionManagerClass,
                                  java.lang.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.

Parameters:
interactionManagerClass - String with the InteractionManager Class name.
formName - String with the Form file name.

applyInteractionManager

protected void applyInteractionManager(java.lang.String interactionManagerClass,
                                       java.lang.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.

updateParentkeys

public void updateParentkeys(OTreeNode node)
Parameters:
node -

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent event)
Specified by:
valueChanged in interface javax.swing.event.TreeSelectionListener

treeWillExpand

public void treeWillExpand(javax.swing.event.TreeExpansionEvent event)
                    throws javax.swing.tree.ExpandVetoException
Specified by:
treeWillExpand in interface javax.swing.event.TreeWillExpandListener
Throws:
javax.swing.tree.ExpandVetoException

treeExpanded

public void treeExpanded(javax.swing.event.TreeExpansionEvent event)
Specified by:
treeExpanded in interface javax.swing.event.TreeExpansionListener

fitSpaceToTree

protected void fitSpaceToTree()
Fits the space to the tree.


getJSPlitPane

public javax.swing.JSplitPane getJSPlitPane()
Gets the JSplitPane reference. If the form manager doesn't have tree this method return null.

Returns:

treeCollapsed

public void treeCollapsed(javax.swing.event.TreeExpansionEvent event)
Specified by:
treeCollapsed in interface javax.swing.event.TreeExpansionListener

treeWillCollapse

public void treeWillCollapse(javax.swing.event.TreeExpansionEvent event)
Specified by:
treeWillCollapse in interface javax.swing.event.TreeWillExpandListener

getCurrentForm

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


dataInserted

public void dataInserted()
This method does that the parent node of current selected node will be selected if the current selected node is a data node.


dataInserted

public void dataInserted(java.util.Hashtable keysValues)
Deprecated.  

This method updates the tree node associated to the active Form.


setLookAndFeel

protected void setLookAndFeel(java.lang.String look)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
Specified by:
actionPerformed in interface java.awt.event.ActionListener

getTree

public Tree getTree()
Gets the Tree reference that is associated to this FormManager

Returns:
Tree reference.

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

finalize

protected void finalize()
                 throws java.lang.Throwable
Throws:
java.lang.Throwable

getResourceBundle

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

Returns:
a ResourceBundle reference

getResourceFileName

public java.lang.String getResourceFileName()

showAvaliableFonts

public java.awt.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(java.awt.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(java.awt.Font f)
Description copied from interface: FontAndEncodingSelector
Set the font to use by the object

Specified by:
useFont in interface FontAndEncodingSelector

getContainer

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

Returns:
a Container reference.

addTopComponent

public void addTopComponent(java.awt.Component component)
Adds the component that is passed as entry parameter to FormManager#panelTop

Parameters:
component -

insertedNode

public void insertedNode(javax.swing.tree.TreePath path,
                         java.util.Hashtable keysValues)
Inserts a new node into the Tree associated to this FormManager

Parameters:
path -
keysValues -

insertedNode

public void insertedNode(javax.swing.tree.TreePath path,
                         java.util.Hashtable keysValues,
                         boolean childSelect)
This method call the insertedNode(TreePath, Hashtable) and the new node will be selected if the condition childSelect is true.

Parameters:
path -
keysValues -
childSelect -

deletedNode

public void deletedNode(javax.swing.tree.TreePath path,
                        java.util.Hashtable keysValues,
                        boolean select)
This method calls the deletedNode method of the Tree associated to this FormManager

Parameters:
path - TreePath to be deleted.
keysValues - a Hashtable with the keys of the record to be deleted.
select - true the next node will be selected

updatedNode

public void updatedNode(javax.swing.tree.TreePath path,
                        java.util.Hashtable attributesValues,
                        java.util.Hashtable keysValues)
Updates the node of the Tree associate to this FormManager.

Parameters:
path - TreePath to be updated.
attributesValues - Hashtable with the values to be updated.
keysValues - Hashtable with the keys of the record which will be updated.

updatedNode

public void updatedNode(javax.swing.tree.TreePath path,
                        java.util.Hashtable attributesValues,
                        java.util.Hashtable keysValues,
                        boolean select)
Updates the node of the Tree associate to this FormManager.

Parameters:
path - TreePath to be updated.
attributesValues - Hashtable with the values to be updated.
keysValues - Hashtable with the keys of the record which will be updated.
select - true if the updated node will be selected.

setId

public void setId(java.lang.String id)
Sets the unique identifier for this FormManager

Parameters:
id - a String with the unique identifier.

getId

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

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.

Parameters:
application -

getApplication

public Application getApplication()
Gets the Application reference.

Returns:
a Application reference

checkVisiblePermission

protected boolean checkVisiblePermission(java.lang.String id)
Checks if this FormManager is restricted with visible permissions

Parameters:
id -
Returns:
false

getAttributeValue

protected java.lang.Object getAttributeValue(java.lang.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.

setProcessingTreeSelectionEvent

public void setProcessingTreeSelectionEvent(boolean process)
Enables/disables the dispatcher the tree selection event.

Parameters:
process - true the dispatcher is enabled

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 java.lang.String getLabelFileURI()

setActiveForm

public void setActiveForm(Form f)

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.

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
Parameters:
e -
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
Parameters:
e -

setApplicationPreferences

public void setApplicationPreferences(ApplicationPreferences ap)

updateInteractionDynamicFormMode

protected void updateInteractionDynamicFormMode(Form form)

setCheckModified

public void setCheckModified(boolean enabled)

reload

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

Parameters:
form - Form reference to be reloaded.

isRestricted

public boolean isRestricted()
Specified by:
isRestricted in interface SecureElement

registerApplicationPreferencesListener

protected void registerApplicationPreferencesListener()

getDelayedLoad

public boolean getDelayedLoad()
Gets the delayed load condition

Returns:
true if the FormManager will delay its loaded.

setFormManagerToForm

public void setFormManagerToForm(java.lang.String formName,
                                 java.lang.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()

getFormBuilder

public FormBuilder getFormBuilder()

Ontimize