com.ontimize.gui.field

Interface FormComponent

All Superinterfaces:

Internationalization

All Known Subinterfaces:

AdvancedDataComponent, DataComponent, DataComponentGroup, ReferenceComponent, ReferenceDataComponent, ValueChangeDataComponent

All Known Implementing Classes:

AbstractButtonSelection, AbstractFormComponent, AbstractMultipleReferenceDataField, AlarmList, AnalogImage, ApplicationMenuBar, ApplicationToolBar, ApToolBarButton, ApToolBarFiller, ApToolBarModule, ApToolBarNavigator, ApToolBarPopupButton, ApToolBarSeparator, ApToolBarToggleButton, AttachmentFileButton, AudioDataField, BackgroundImageGroup, BasicDataComponentGroup, BasicTree, BooleanCellEditor, BooleanComboDataField, Button, ButtonBar, ButtonGroupDataField, CalculatedCurrencyDataField, CalculatedDataField, CalculatedExpressionDataField, CalculatedTextDataField, CalendarDataField, CalendarSpinnerDataField, CardPanel, CellEditor, Chart, Chart_1_0, CheckDataField, CheckMenuItem, CheckToggleImage, CIFDataField, CollapsibleGroup, CollapsibleGroupPanel, CollapsiblePanel, CollapsiblePanelFiller, ColorDataField, Column, ColumnRadioButtonGroup, ComboCellEditor, ComboDataField, ComboReferenceCellEditor, ComboReferenceCellEditor.ExtCampoComboRef, ComboReferenceCellRenderer, ConfigureFormBundleDialog.CustomComboCellEditor, CurrencyCellEditor, CurrencyDataField, DataField, DataLabel, DateCellEditor, DateDataField, DeleteAttachmentButton, DictionaryDataField, DownloadAttachmentFileButton, EntityFunctionDataField, EntityResultViewer, ExtendedMultiReference, ExtendedTable, FileDataField, FilterButton, FilterComponent, FilterTableDataField, Form, Form2HTMLDataField, FormBundleButton, FormExt, FormHeader, FormHeaderButton, FormHeaderPopupButton, GenerateReportButton, Grid, HelpButton, HorizontalSeparator, HourDateDataField, HTMLComponent, HTMLDataField, HtmlHelpField, HTMLLabel, HTMLShefDataField, HTMLTemplate, HyperlinkLabel, IdentifiedAbstractFormComponent, ImageCellRenderer, ImageDataField, ImageField, IntegerCellEditor, IntegerDataField, JAIImageDataField, JImage, JImageContainer, Label, LinkComponent, ListDataField, LocaleMenuItem, MaskCellEditor, MaskDataField, MemoCellEditor, MemoDataField, MemoryMonitorComponent, Menu, MenuItem, MenuLocale, MenuRadioButtonGroup, MenuSeparator, MonthComboDataField, MoveBetweenTablesButton, MultipleReferenceComboDataField, MultipleReferenceDataField, MultiReference, NavigatorMenuGUI, NIFDataField, NoticeTable, ObjectDataField, OpenAppWindowsButton, OpenTemplateButton, PasswordDataField, PercentDataField, PermissionTree, PivotTable, QueryButton, QueryFilterButton, RadioButtonDataField, RadioItemGroup, RadioMenuItem, RealCellEditor, RealDataField, ReferenceCellEditor, ReferenceComboDataField, ReferenceDataField, ReferenceExtDataField, RefreshTableButton, Row, RowRadioButtonGroup, RTFDataField, ScriptButton, Scroll, SelectionListDataField, ServerPermissionManagerComponent, SignDataField, SliderDataField, SpinnerCellEditor, SpinnerDataField, SplitPane, StringCellEditor, SubForm, SurfaceChartComponent, Tab, Table, Table2Forms, TabPanel, TextArea, TextComboDataField, TextDataField, TextFieldDataField, ToggleButton, ToggleImage, TwoLevelContainer, TwoLevelImageComponent, WWWDataField, XMLDataField

public interface FormComponent
extends Internationalization

This interface defines the methods that allows to initialize objects with their parameters, also allows to get information about their position in forms and finally, sets this active or inactive state. All components that will be created by xml constructor must implement this interface and a public constructor like:
public constructor(Hashtable params)

Author:

Imatia Innovation

Field Summary

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

DEBUG_LANGUAGE

Method Summary

Methods

Modifier and Type	Method and Description
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
void	init(Hashtable parameters) Main method to init an object from parameters hashtable.
boolean	isEnabled() Description method to check when a component is or not enabled.
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setVisible(boolean visible) Description method to set visible or not the component according the boolean condition in parameter.

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

getTextsToTranslate, setComponentLocale, setResourceBundle

Method Detail

init

void init(Hashtable parameters)
          throws Exception

Main method to init an object from parameters hashtable.

Parameters:

parameters - the hashtable with pairs (Key,Value). For example:

Key	Value
align	center
attr	attribute
...	...

Throws:

Exception - when Exception occurs

getConstraints

Object getConstraints(LayoutManager parentLayout)

Description method to return the constraints component to place correctly in parent container.

Parameters:

parentLayout - the parent container reference

Returns:

the constraints for the component

setEnabled

void setEnabled(boolean enabled)

Description method to set enabled or not the component according the boolean condition in parameter.

Parameters:

enabled - the enabled condition

setVisible

void setVisible(boolean visible)

Description method to set visible or not the component according the boolean condition in parameter.

Parameters:

visible - the visibility condition

isEnabled

boolean isEnabled()

Description method to check when a component is or not enabled.

Returns:

the enabled condition