com.ontimize.gui.manager

Interface IFormManager

All Superinterfaces:

DataNavigationListener, EventListener, FontAndEncodingSelector, Freeable, Internationalization, SecureElement, SelectCurrencyValues

All Known Subinterfaces:

ITabbedFormManager, ITreeFormManager

All Known Implementing Classes:

BaseFormManager, FormManager, TabbedFormManager

public interface IFormManager
extends Internationalization, SecureElement, Freeable, SelectCurrencyValues, FontAndEncodingSelector, DataNavigationListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION XML Attribute
static String	APPLICATION XML Attribute
static String	CONTAINER XML Attribute
static String	DELAYED_LOAD XML Attribute
static String	DETAIL
static String	DYNAMIC_FORM XML Attribute
static String	FORM XML Attribute
static String	FORM_BUILDER XML Attribute
static String	FRAME XML Attribute
static String	ICON XML Attribute
static String	ID XML Attribute
static String	IM_LOADER XML Attribute
static String	INTERACTION_MANAGER XML Attribute
static String	LOAD XML Attribute
static String	LOCATOR XML Attribute
static String	RESOURCES XML Attribute
static String	RULE_LOADER XML Attribute
static String	RULES XML Attribute
static String	SHOW_FRAME XML Attribute
static String	USE_CLASS_PATH XML Attribute

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormToContainer(JPanel panelForm, String formFileName)
Form	getActiveForm() Returns the active Form reference.
Application	getApplication() Gets the Application reference.
Container	getContainer()
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)
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()
Locale	getLocale()
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()
URL	getURL(String formName) Gets the Form URL which name is passed as entry parameter.
boolean	isLoaded()
void	load() Loads the FormManager.The initial Form, initial InteractionManager and Tree are instanced and are layered out in container to be shown.
void	loadInEDTh()
void	reload(Form form)
void	setActiveForm(Form f)
void	setApplication(Application application)
void	setApplicationPreferences(ApplicationPreferences ap)
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.
void	setReferenceLocator(EntityReferenceLocator locator)
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	showFormInEDTh(String form)
boolean	showFrame() Determines whether this FormManager should be shown in a new Frame.

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

getTextsToTranslate, setComponentLocale, setResourceBundle

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Methods inherited from interface com.ontimize.gui.Freeable

free

Methods inherited from interface com.ontimize.gui.SelectCurrencyValues

showCurrencyValue

Methods inherited from interface com.ontimize.gui.FontAndEncodingSelector

showAvaliableFonts, useFont

Methods inherited from interface com.ontimize.gui.DataNavigationListener

dataChanged, dataWillChange

Field Detail

FORM_BUILDER

static final String FORM_BUILDER

XML Attribute

See Also:

Constant Field Values

FRAME

static final String FRAME

XML Attribute

See Also:

Constant Field Values

CONTAINER

static final String CONTAINER

XML Attribute

See Also:

Constant Field Values

USE_CLASS_PATH

static final String USE_CLASS_PATH

XML Attribute

See Also:

Constant Field Values

APPLICATION

static final String APPLICATION

XML Attribute

See Also:

Constant Field Values

LOCATOR

static final String LOCATOR

XML Attribute

See Also:

Constant Field Values

DETAIL

static final String DETAIL

See Also:

Constant Field Values

IM_LOADER

static final String IM_LOADER

XML Attribute

See Also:

Constant Field Values

RULE_LOADER

static final String RULE_LOADER

XML Attribute

See Also:

Constant Field Values

DELAYED_LOAD

static final String DELAYED_LOAD

XML Attribute

See Also:

Constant Field Values

DYNAMIC_FORM

static final String DYNAMIC_FORM

XML Attribute

See Also:

Constant Field Values

RESOURCES

static final String RESOURCES

XML Attribute

See Also:

Constant Field Values

INTERACTION_MANAGER

static final String INTERACTION_MANAGER

XML Attribute

See Also:

Constant Field Values

FORM

static final String FORM

XML Attribute

See Also:

Constant Field Values

RULES

static final String RULES

XML Attribute

See Also:

Constant Field Values

ACTION

static final String ACTION

XML Attribute

See Also:

Constant Field Values

LOAD

static final String LOAD

XML Attribute

See Also:

Constant Field Values

ID

static final String ID

XML Attribute

See Also:

Constant Field Values

SHOW_FRAME

static final String SHOW_FRAME

XML Attribute

See Also:

Constant Field Values

ICON

static final String ICON

XML Attribute

See Also:

Constant Field Values

Method Detail

getId

String getId()

Gets the unique identifier for this FormManager

Returns:

a String with the unique identifier.

loadInEDTh

void loadInEDTh()

getURL

URL getURL(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

reload

void reload(Form form)

getReferenceLocator

EntityReferenceLocator getReferenceLocator()

Gets the EntityReferenceLocator reference that is stored inside.

Returns:

a EntityReferenceLocator

getApplication

Application getApplication()

Gets the Application reference.

Returns:

a Application reference

getRuleEngine

RuleEngine getRuleEngine()

getFormBuilder

FormBuilder getFormBuilder()

getLabelFileURI

String getLabelFileURI()

getLocale

Locale getLocale()

getResourceBundle

ResourceBundle getResourceBundle()

Gets the ResourceBundle reference stored in this FormManager

Returns:

a ResourceBundle reference

getResourceFileName

String getResourceFileName()

Gets the ResourceBundle name stored in this FormManager

Returns:

a String reference

getFormCopy

Form getFormCopy(String formName)

Gets a Form instance copy which form name is passed as entry parameter.

Parameters:

formName - a String with the Form name.

getFormCopy

Form getFormCopy(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. This method calls the getFormCopyInEDTh(java.lang.String) 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.

getFormCopyInEDTh

Form getFormCopyInEDTh(String formName)

getFormCopy

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) 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.

load

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.

setInteractionManager

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.

Parameters:

interactionManager - InteractionManager reference where the Form is registered in.

formName - a String with the Form file name.

setInteractionManager

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.

Parameters:

interactionManagerClass - String with the InteractionManager Class name.

formName - String with the Form file name.

getInteractionManager

InteractionManager getInteractionManager(String formName)

showForm

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. 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

boolean showFormInEDTh(String form)

setActiveForm

void setActiveForm(Form f)

getActiveForm

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:

addFormToContainer

void addFormToContainer(JPanel panelForm,
                      String formFileName)

getContainer

Container getContainer()

setApplication

void setApplication(Application application)

setReferenceLocator

void setReferenceLocator(EntityReferenceLocator locator)

setApplicationPreferences

void setApplicationPreferences(ApplicationPreferences ap)

isLoaded

boolean isLoaded()

getFormReference

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.

Parameters:

formName - a Form name.

loadIfNecessary - true to be loaded the FormManager

getFormReference

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

showFrame

boolean showFrame()

Determines whether this FormManager should be shown in a new Frame.

Returns:

true if is shown in a new Frame

getIcon

String getIcon()

Determines the icon that should be shown in a new Frame

Returns: