com.ontimize.gui.field
Interface DataComponent

All Superinterfaces:

FormComponent, IdentifiedElement, Internationalization, SecureElement

All Known Subinterfaces:

AdvancedDataComponent, ReferenceDataComponent, ValueChangeDataComponent

All Known Implementing Classes:

AbstractMultipleReferenceDataField, AlarmList, AnalogImage, ButtonGroupDataField, CalculatedExpressionDataField, CalendarDataField, Chart, Chart_0_9, Chart_1_0, CheckDataField, CheckToggleImage, CurrencyDataField, DataField, DataLabel, DateDataField, EntityResultViewer, ExtendedTable, Form2HTMLDataField, HTMLDataField, ImageDataField, IntegerDataField, MultiReference, PivotTable, RealDataField, ReferenceComboDataField, ReferenceDataField, ReferenceExtDataField, RTFDataField, SliderDataField, SubForm, Table, TwoLevelContainer, TwoLevelImageComponent

public interface DataComponent

extends FormComponent, IdentifiedElement

This interface defines methods used by data components:

• getLabelComponentText()
• getValue()
• setValue(Object value)
• deleteData()
• isEmpty()
• isModifiable()
• setModifiable()
• isHidden()
• getSQLDataType()
• isRequired()
• isModified()
• setRequired()

It is also defined constants for colors.

See Also:

Innovation

Field Summary

static java.awt.Color	COMP_FOCUS_YELLOW The yellow color for focus key.
static java.awt.Color	GREEN_VERY_LIGHT The very light green color key.
static java.awt.Color	LIGHT_GRAY_BLUE The very light gray blue color key.
static java.awt.Color	LIGHT_GREYISH_BLUE The very light greyish color key.
static java.awt.Color	VERY_LIGHT_BLUE The very light blue color key.
static java.awt.Color	VERY_LIGHT_GRAY The very light gray color key.
static java.awt.Color	VERY_LIGHT_PINK The very light pink color key.
static java.awt.Color	VERY_LIGHT_RED The very light red color key.
static java.awt.Color	VERY_LIGHT_SKYBLUE The very light skyblue color key.
static java.awt.Color	VERY_LIGHT_YELLOW The very light yellow color key.
static java.awt.Color	VERY_LIGHT_YELLOW_2 The very light yellow color key.

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

DEBUG

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

DEBUG_LANGUAGE

Fields inherited from interface com.ontimize.gui.SecureElement

DESACTIVATE_COMPONENT_BY_PERMISSION_TIP

Method Summary

void	deleteData() The method to delete data for component.
java.lang.String	getLabelComponentText() Returns the label text component.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
java.lang.Object	getValue() Gets the value of a component.
boolean	isEmpty() Checks the data existence in component.
boolean	isHidden() Indicates to check the visibility condition for a component.
boolean	isModifiable() Checks the modifiable condition for a component.
boolean	isModified() This method should be return true when data have been modified.
boolean	isRequired() Indicates the required condition for a component.
void	setModifiable(boolean modifiable) Establishes the modifiable condition for a component.
void	setRequired(boolean required) Sets required a component according to condition.
void	setValue(java.lang.Object value) Sets the value for component.

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

getConstraints, init, isEnabled, setEnabled, setVisible

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

getTextsToTranslate, setComponentLocale, setResourceBundle

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

getAttribute

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

VERY_LIGHT_GRAY

public static final java.awt.Color VERY_LIGHT_GRAY

The very light gray color key.

VERY_LIGHT_PINK

public static final java.awt.Color VERY_LIGHT_PINK

The very light pink color key.

VERY_LIGHT_BLUE

public static final java.awt.Color VERY_LIGHT_BLUE

The very light blue color key.

VERY_LIGHT_SKYBLUE

public static final java.awt.Color VERY_LIGHT_SKYBLUE

The very light skyblue color key.

GREEN_VERY_LIGHT

public static final java.awt.Color GREEN_VERY_LIGHT

The very light green color key.

VERY_LIGHT_YELLOW

public static final java.awt.Color VERY_LIGHT_YELLOW

The very light yellow color key. RGB: (253,252,210).

VERY_LIGHT_YELLOW_2

public static final java.awt.Color VERY_LIGHT_YELLOW_2

The very light yellow color key. RGB: (253,252,220).

COMP_FOCUS_YELLOW

public static final java.awt.Color COMP_FOCUS_YELLOW

The yellow color for focus key.

VERY_LIGHT_RED

public static final java.awt.Color VERY_LIGHT_RED

The very light red color key.

LIGHT_GREYISH_BLUE

public static final java.awt.Color LIGHT_GREYISH_BLUE

The very light greyish color key.

LIGHT_GRAY_BLUE

public static final java.awt.Color LIGHT_GRAY_BLUE

The very light gray blue color key.

Method Detail

getLabelComponentText

public java.lang.String getLabelComponentText()

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

Returns:

the label text

getValue

public java.lang.Object getValue()

Gets the value of a component.

Returns:

the object with value.

setValue

public void setValue(java.lang.Object value)

Sets the value for component.

Parameters:

value - the object with value to set

deleteData

public void deleteData()

The method to delete data for component.

isEmpty

public boolean isEmpty()

Checks the data existence in component.

Returns:

true when component is empty

isModifiable

public boolean isModifiable()

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

Returns:

true when component is modifiable

setModifiable

public void setModifiable(boolean modifiable)

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

Parameters:

modifiable - the boolean condition

isHidden

public boolean isHidden()

Indicates to check the visibility condition for a component.

Returns:

the visibility condition

getSQLDataType

public int getSQLDataType()

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

Returns:

the Integer type

isRequired

public boolean isRequired()

Indicates the required condition for a component.

Returns:

the required condition

isModified

public boolean isModified()

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

Returns:

the modified condition

setRequired

public void setRequired(boolean required)

Sets required a component according to condition.

Parameters:

required - the required condition