com.ontimize.gui.field

Class CheckDataField

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.field.DataField

com.ontimize.gui.field.CheckDataField

All Implemented Interfaces:

AccessForm, AdvancedDataComponent, DataComponent, FormComponent, IdentifiedElement, HasHelpIdComponent, Internationalization, ApplicationPreferencesListener, HasPreferenceComponent, SecureElement, ValueChangeDataComponent, ITemplateField, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

RadioButtonDataField

public class CheckDataField
extends DataField
implements AdvancedDataComponent, ITemplateField

This class create a checkbox field where methods getValue and setValue use Integer with '1' for selected value and '0' for deselected value.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CheckDataField.CheckBoxUIE This class provides a Windows checkbox.
protected class	CheckDataField.InnerListener This class implements an inner listener for field.

Nested classes/interfaces inherited from class com.ontimize.gui.field.DataField

DataField.AuxPanel, DataField.CopyActionListener, DataField.ELabel, DataField.FieldButton, DataField.FieldFocusListener, DataField.InfoMouseListener, DataField.ToggleButton

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 Border	borderNotIncluded An instance of a line and a bevel border definition.
static ImageIcon	defaultDeselectIcon
static ImageIcon	defaultSelectIcon
static String	DESELECT_ICON Key for unselected icon.
static Integer	deselectedValue Numeric value that indicates the value to store when check is deselected.
protected ImageIcon	deselectIcon
static String	INCLUDE_MENU_KEY The key to include the menu key.
protected JCheckBoxMenuItem	includeMenu An instance of checkbox menu item.
protected CheckDataField.InnerListener	innerListener An instance for a inner listener.
static String	NO The 'no' condition.
protected boolean	returnBoolean The returned boolean.
static String	RETURNBOOLEAN Key for return boolean parameter.
protected boolean	returnString The returned string.
static String	RETURNSTRING Key for return string parameter.
static String	SELECT_ICON Key for selected icon.
static Integer	selectedValue Numeric value that indicates the value to store when check is selected.
protected ImageIcon	selectIcon
static Integer	UNO Deprecated. 5.2059EN
static String	YES The 'yes' condition.
static Integer	ZERO Deprecated. 5.2059EN

Fields inherited from class com.ontimize.gui.field.DataField

advancedQueryMode, ALIGN, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, alignment, ASTERISK_REQUIRED_STYLE, ATTR, attribute, backgroundColor, BGCOLOR, bold, BOLD, BORDER, BORDER_REQUIRED_STYLE, borderText, BOTTOM, CENTER, CLIPBOARD_COPY, CLIPBOARD_COPY_es_ES, CLIPBOARD_CUT, CLIPBOARD_CUT_es_ES, CLIPBOARD_PASTE, CLIPBOARD_PASTE_es_ES, conditions, dataField, DEFAULT_BORDER, DEFAULT_BOTTOM_MARGIN, DEFAULT_FIELD_LEFT_MARGIN, DEFAULT_FIELD_RIGHT_MARGIN, DEFAULT_LABEL_LEFT_MARGIN, DEFAULT_LABEL_RIGHT_MARGIN, DEFAULT_PARENT_MARGIN, DEFAULT_PARENT_MARGIN_FOR_SCROLL, DEFAULT_TOP_MARGIN, defaultAsteriskColor, DEFAULTBORDER, defaultDisableBackgroundColor, defaultFieldButtonHigh, defaultPreferenceTextNotRetrievedFromPreferences, DEFINE_HELP_FIELD_PREFERENCE, dim, DIM, disabledbgcolor, DISABLEDBGCOLOR, empty, enabled, ENABLED, EXPAND, FIELD_HELP_TIP, fieldlistenerFocus, fieldSize, fireValueEvents, FOCUS_BACKGROUNDCOLOR, FONT, fontColor, FONTCOLOR, fontSize, FONTSIZE, height, HEIGHT, incrementalFont, initPreferenceHelpText, INSETS, isEnabled, LABELALIGN, labelComponent, LABELFONT, LABELFONTCOLOR, labelPosition, LABELPOSITION, LABELSIZE, labelText, LABELVISIBLE, LEFT, locale, LOWERED, menuCopy, menuCut, menuDefineHelpPreference, menuHelpPreferences, menuPaste, modifiable, NO_STR, NONE, noRequiredBorder, OPAQUE, originalSize, OUTBORDER, panel, parentForm, permissionActivate, permissionVisible, popupMenu, PREF_WIDTH, prefWidth, RAISED, redimensionPanel, redimensJTextField, required, REQUIRED, requiredBorder, REQUIREDBORDER, requiredFieldBackgroundColor, requiredFieldForegroundColor, resources, restricted, RIGHT, show, showLabel, SIZE, TEXT_STR, TEXTALIGN, textAlignment, textHelpPreference, TIP, tipKey, TOP, validData, VALIGN, Valignment, valueListener, valueSave, VISIBLE, VISUALIZE_HELP_FIELD_PREFERENCE, weightDataFieldH, weightPanelH, width, WIDTH, x, X, y, Y, YES_STR

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

ADVANCED_QUERY

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

COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2

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.util.templates.ITemplateField

DATA_TYPE_FIELD, DATA_TYPE_FIELD_ATTR, DATA_TYPE_IMAGE, DATA_TYPE_IMAGE_ATTR, DATA_TYPE_TABLE, DATA_TYPE_TABLE_ATTR, TEMPLATE_DATA_TYPE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, PROPERTIES, SOMEBITS

Constructor Summary

Constructors

Constructor and Description
CheckDataField(Hashtable parameters) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemListener(ItemListener cl) Adds an ItemListener to the checkbox.
protected void	createDataField() Creates the checkbox.
protected void	createPopupMenu() Creates a pop-up menu.
void	deleteData() The method to delete data for component.
AbstractButton	getAbstractButton() Gets a reference of an AbstractButton of this field.
Object	getAttribute() Gets the object attribute.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
int	getTemplateDataType() Returns the data type.
Object	getTemplateDataValue() Gets the value to show in the template
String	getText() Gets text.
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
Object	getValue() Gets the value of a component.
void	init(Hashtable parameters) Initializes parameters and selects the bundle equals to class ResourceBundle, adding a suffix to basic file name.
protected void	installLabelListener() Installs the label listener.
boolean	isEmpty() Checks the data existence in component.
boolean	isSelected() Checks the selected condition.
void	removeItemListener(ItemListener cl) Removes an ItemListener to the checkbox.
void	setAdvancedQueryMode(boolean enabled) This method must establish the advanced query state, to support advanced query conditions.
void	setComponentLocale(Locale l)
void	setEnabled(boolean enabled) Enables the field to insert data.
protected void	setInnerListenerEnabled(boolean enable) Enables the inner listener.
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setValue(Object value) Sets the value for component.
protected void	showPopupMenu(Component c, int x, int y) Shows the pop-up menu.

Methods inherited from class com.ontimize.gui.field.DataField

addFocusListener, addHelpMenuPopup, addValueChangeListener, changeButton, changeOpacity, checkDefineHelpPermission, checkEnabledPermission, checkVisiblePermission, configurePopupMenuHelp, createFocusListener, createInstanceConditionCombo, defineHelpField, finalize, fireValueChanged, getBorder, getConstraints, getDataField, getDisabledbgcolor, getFontColor, getHelpIdString, getHelpPreferenceKey, getLabelComponent, getLabelComponentText, getLabelFontColor, getLabelText, getParentForm, getPreferenceHelpText, getPreferredSize, getValueChangeListeners, hasHelpInPreferences, initPermissions, initPreferences, installFocusListener, installHelpId, installPopupMenuListener, installPreferenceHelpListener, isAdvancedQueryMode, isEnabled, isHidden, isLabelVisible, isModifiable, isModified, isRequired, isRestricted, parseBoolean, preferenceChanged, removeFocusListener, removeValueChangeListener, requestFocus, seeHelpField, setBold, setDisabledbgcolor, setFont, setFontColor, setFontSize, setLabelFontColor, setModifiable, setParentForm, setRequired, setRequiredFieldBackground, setVisible, updateBackgroundColor, updateBackgroundColor, updateFont, updateTip, updateUI, validateComponentPositions

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, 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, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, 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, 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.field.DataComponent

getLabelComponentText, isHidden, isModifiable, isModified, isRequired, setModifiable, setRequired

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

getConstraints, isEnabled, setVisible

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

UNO

@Deprecated
public static final Integer UNO

Deprecated. 5.2059EN

The activated value (1).

See Also:

selectedValue

ZERO

@Deprecated
public static final Integer ZERO

Deprecated. 5.2059EN

The disable value (0).

See Also:

deselectedValue

SELECT_ICON

public static final String SELECT_ICON

Key for selected icon.

See Also:

Constant Field Values

DESELECT_ICON

public static final String DESELECT_ICON

Key for unselected icon.

See Also:

Constant Field Values

RETURNSTRING

public static final String RETURNSTRING

Key for return string parameter.

See Also:

Constant Field Values

RETURNBOOLEAN

public static final String RETURNBOOLEAN

Key for return boolean parameter.

See Also:

Constant Field Values

selectedValue

public static Integer selectedValue

Numeric value that indicates the value to store when check is selected.

Since:

5.2059EN

deselectedValue

public static Integer deselectedValue

Numeric value that indicates the value to store when check is deselected. By default 0.

Since:

5.2059EN

YES

public static String YES

The 'yes' condition.

NO

public static String NO

The 'no' condition.

returnBoolean

protected boolean returnBoolean

The returned boolean. By default, false.

returnString

protected boolean returnString

The returned string. By default, false.

INCLUDE_MENU_KEY

public static String INCLUDE_MENU_KEY

The key to include the menu key.

includeMenu

protected JCheckBoxMenuItem includeMenu

An instance of checkbox menu item.

borderNotIncluded

protected Border borderNotIncluded

An instance of a line and a bevel border definition.

innerListener

protected CheckDataField.InnerListener innerListener

An instance for a inner listener.

defaultSelectIcon

public static ImageIcon defaultSelectIcon

defaultDeselectIcon

public static ImageIcon defaultDeselectIcon

selectIcon

protected ImageIcon selectIcon

deselectIcon

protected ImageIcon deselectIcon

Constructor Detail

CheckDataField

public CheckDataField(Hashtable parameters)

The class constructor. Creates the field, inits parameters, sets transparent and adds listeners.

Parameters:

parameters - the Hashtable with parameters

Method Detail

installLabelListener

protected void installLabelListener()

Installs the label listener.

createDataField

protected void createDataField()

Creates the checkbox.

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: DataField

Enables the field to insert data.

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class DataField

Parameters:

enabled - the condition to set enable

init

public void init(Hashtable parameters)

Initializes parameters and selects the bundle equals to class ResourceBundle, adding a suffix to basic file name.

Specified by:

init in interface FormComponent

Overrides:

init in class DataField

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
returnboolean	yes/no	no	no	Indicates whether getValue() returns a boolean. By default, returns an Integer.
returnstring	yes/no	no	no	Indicates whether returns the value in String format.(S->True, N->False)
selecticon			no	Path to icon used when check is selected.
deselecticon			no	Path to icon used when check is unselected.

getValue

public Object getValue()

Description copied from interface: DataComponent

Gets the value of a component.

Specified by:

getValue in interface DataComponent

Returns:

the object with value.

setInnerListenerEnabled

protected void setInnerListenerEnabled(boolean enable)

Enables the inner listener.

Parameters:

enable - the condition

setValue

public void setValue(Object value)

Description copied from interface: DataComponent

Sets the value for component.

Specified by:

setValue in interface DataComponent

Parameters:

value - the object with value to set

getAttribute

public Object getAttribute()

Description copied from interface: IdentifiedElement

Gets the object attribute. This attribute allows to identify the object

Specified by:

getAttribute in interface IdentifiedElement

Overrides:

getAttribute in class DataField

deleteData

public void deleteData()

Description copied from interface: DataComponent

The method to delete data for component.

Specified by:

deleteData in interface DataComponent

isEmpty

public boolean isEmpty()

Description copied from interface: DataComponent

Checks the data existence in component.

Specified by:

isEmpty in interface DataComponent

Returns:

true when component is empty

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

Overrides:

setComponentLocale in class DataField

getSQLDataType

public int getSQLDataType()

Description copied from interface: DataComponent

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

Specified by:

getSQLDataType in interface DataComponent

Returns:

the Integer type

addItemListener

public void addItemListener(ItemListener cl)

Adds an ItemListener to the checkbox.

Parameters:

cl - the item listener to be added

removeItemListener

public void removeItemListener(ItemListener cl)

Removes an ItemListener to the checkbox.

Parameters:

cl - the item listener to be removed

createPopupMenu

protected void createPopupMenu()

Description copied from class: DataField

Creates a pop-up menu.

Overrides:

createPopupMenu in class DataField

showPopupMenu

protected void showPopupMenu(Component c,
                 int x,
                 int y)

Description copied from class: DataField

Shows the pop-up menu.

Overrides:

showPopupMenu in class DataField

Parameters:

c - the component

x - the x coordinate

y - the y coordinate

isSelected

public boolean isSelected()

Checks the selected condition.

Returns:

the selected condition

setAdvancedQueryMode

public void setAdvancedQueryMode(boolean enabled)

Description copied from interface: AdvancedDataComponent

This method must establish the advanced query state, to support advanced query conditions.

Specified by:

setAdvancedQueryMode in interface AdvancedDataComponent

Parameters:

enabled - the condition to enable this state

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

Overrides:

getTextsToTranslate in class DataField

Returns:

all the texts in the element suitable for being translated.

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

Overrides:

setResourceBundle in class DataField

Parameters:

resources - the new language bundle.

getText

public String getText()

Description copied from class: DataField

Gets text.

Overrides:

getText in class DataField

Returns:

the text in this implementation returns null.

getAbstractButton

public AbstractButton getAbstractButton()

Gets a reference of an AbstractButton of this field.

Returns:

getTemplateDataType

public int getTemplateDataType()

Description copied from interface: ITemplateField

Returns the data type. The values that can return are: ITemplateField.DATA_TYPE_FIELD ITemplateField.DATA_TYPE_IMAGE ITemplateField.DATA_TYPE_TABLE

Specified by:

getTemplateDataType in interface ITemplateField

Returns:

a int with the data type.

getTemplateDataValue

public Object getTemplateDataValue()

Description copied from interface: ITemplateField

Gets the value to show in the template

Specified by:

getTemplateDataValue in interface ITemplateField

Returns: