com.ontimize.gui.container

Class MultiReference

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.container.Column

com.ontimize.gui.container.MultiReference

All Implemented Interfaces:

AccessForm, DataComponent, FormComponent, IdentifiedElement, Internationalization, OpenDialog, ReferenceComponent, SecureElement, ImageObserver, MenuContainer, Serializable, Accessible

public class MultiReference
extends Column
implements OpenDialog, ReferenceComponent, DataComponent, AccessForm

Implements a data component group where data are used like an entity for a component. To perform a query when focus is lost, component should be a field.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

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 JPanel	buttonPanel An instance of a button panel with alignment to left.
protected Hashtable	dataComponents A reference to a data components.
protected JButton	deleteButton An instance of a delete button.
protected String	entity The entity reference.
protected FocusAdapter	focusListener An instance of focus adapter to manage the loss focus.
protected String	key The key reference.
protected EntityReferenceLocator	locator A reference to locator.
protected boolean	modificable The modifiable condition.
protected JButton	okButton An instance of a accept button.
protected Frame	parentFrame A reference to a parent frame.
protected String	parentKey The parentkey reference.
protected JButton	queryButton An instance of a query button.
protected boolean	required The required condition.
protected boolean	show The condition to show.
protected Object	storedValue An object to store data.
protected Table	t A reference to a table.
protected JDialog	tableWindow A reference to a table window.

Fields inherited from class com.ontimize.gui.container.Column

ABOVE_BOTTOM, ABOVE_TOP, activedPermission, alignment, alignmentV, attribute, B_BEVEL_LOWERED, B_BEVEL_RAISED, B_COLOR, B_LOWERED, B_RAISED, backgroundImage, backgroundPaint, BELOW_BOTTOM, BELOW_TOP, BEVEL_LOWERED, BEVEL_RAISED, borderPosition, BOTTOM, COLOR, COLUMN, EXPANDLAST, horizontalExpand, horizontalWeight, lastExpand, LOWERED, parentForm, preferredHigh, preferredWidht, r, RAISED, restricted, texturePaint, title, titledBorder, titleToUpperCase, TOP, VALIGN, visiblePermission

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.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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
MultiReference(Hashtable params) Class constructor, calls to Column constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkComponentListOK() Creates the form component list manages by this object.
void	deleteData() The method to delete data for component.
Object	getAttribute() Gets the object attribute.
String	getLabelComponentText() Returns the label text component.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
Object	getValue() Gets the value of a component.
Hashtable	getValues() Returns the not null field values associated to this object.
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	setCode(Object code) This method is similar to introduce the code into the field from user interface.
protected void	setComponentValue(Object attribute, Object value) Sets the component value.
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setModifiable(boolean modif) Establishes the modifiable condition for a component.
void	setParentForm(Form f) Method declaration to set the form that contains the component.
void	setParentFrame(Frame marco) This method is called from Form for each component that implements this interface.
void	setReferenceLocator(EntityReferenceLocator locator) Establishes the reference locator that will be used by component.
void	setRequired(boolean required) Sets required a component according to condition.
void	setValue(Object value) Sets the value for component.

Methods inherited from class com.ontimize.gui.container.Column

checkEnabledPermission, checkVisiblePermission, getConstraints, getMaximumSize, getMinimumSize, getName, getPreferredSize, getTextsToTranslate, init, initPermissions, isFocusable, isRestricted, paintComponent, setBackgroundImage, setBackgroundPaint, setComponentLocale, setResourceBundle, setVisible

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, 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, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, 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, addFocusListener, 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, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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, removeFocusListener, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getConstraints, init, isEnabled, setVisible

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

getTextsToTranslate, setComponentLocale, setResourceBundle

Methods inherited from interface com.ontimize.gui.SecureElement

initPermissions, isRestricted

Field Detail

storedValue

protected Object storedValue

An object to store data. By default, null.

required

protected boolean required

The required condition. By default, false.

modificable

protected boolean modificable

The modifiable condition. By default, true.

show

protected boolean show

The condition to show. By default, true.

entity

protected String entity

The entity reference. By default, null.

key

protected String key

The key reference. By default, null.

parentKey

protected String parentKey

The parentkey reference. By default, null.

tableWindow

protected JDialog tableWindow

A reference to a table window. By default, null.

t

protected Table t

A reference to a table. By default, null.

locator

protected EntityReferenceLocator locator

A reference to locator. By default, null.

parentFrame

protected Frame parentFrame

A reference to a parent frame. By default, null.

dataComponents

protected Hashtable dataComponents

A reference to a data components. By default, null.

queryButton

protected JButton queryButton

An instance of a query button.

deleteButton

protected JButton deleteButton

An instance of a delete button.

okButton

protected JButton okButton

An instance of a accept button.

buttonPanel

protected JPanel buttonPanel

An instance of a button panel with alignment to left.

See Also:

FlowLayout.LEFT

focusListener

protected FocusAdapter focusListener

An instance of focus adapter to manage the loss focus.

Constructor Detail

MultiReference

public MultiReference(Hashtable params)
               throws Exception

Class constructor, calls to Column constructor.

Parameters:

params - the hashtable with parameters.

attribute	values	default	required	meaning
entity			yes	Associated entity.
title		entity	no	The title.
key			yes	Attribute for data component. It is the primary key for entity.

Table parameters supported:
attribute	values	default	required	meaning
parentkey			no	To establish a filter. It will be a constraint for all queries in entity.
form			no	Form associated to the table.
otherkeys	field1;...;fieldN			Name of the other fields that are parentkeys, that are passed to the detail form when it is open. These values will be get from the parent form, in which the Table is placed.
controls	yes/no	yes		Allows the Table to have some control buttons, in the top of it. This buttons, by default, can export to excel the data in the table, show charts, reports, and so on. If the value is not, the controlsvisible attribute will not affect.

Throws:

Exception

Method Detail

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.

getValues

public Hashtable getValues()

Returns the not null field values associated to this object. Returns null when getValue() returns null.

Returns:

a Hashtable with attributes and values

setComponentValue

protected void setComponentValue(Object attribute,
                     Object value)

Sets the component value. Calls to setValue(Object)

Parameters:

attribute - the attribute to set value

value - the object to set to attribute

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

isRequired

public boolean isRequired()

Description copied from interface: DataComponent

Indicates the required condition for a component.

Specified by:

isRequired in interface DataComponent

Returns:

the required condition

setRequired

public void setRequired(boolean required)

Description copied from interface: DataComponent

Sets required a component according to condition.

Specified by:

setRequired in interface DataComponent

Parameters:

required - the required condition

isModified

public boolean isModified()

Description copied from interface: DataComponent

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

Specified by:

isModified in interface DataComponent

Returns:

the modified condition

isHidden

public boolean isHidden()

Description copied from interface: DataComponent

Indicates to check the visibility condition for a component.

Specified by:

isHidden in interface DataComponent

Returns:

the visibility condition

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

setModifiable

public void setModifiable(boolean modif)

Description copied from interface: DataComponent

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

Specified by:

setModifiable in interface DataComponent

Parameters:

modif - the boolean condition

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: FormComponent

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

Specified by:

setEnabled in interface FormComponent

Overrides:

setEnabled in class Column

Parameters:

enabled - the enabled condition

isModifiable

public boolean isModifiable()

Description copied from interface: DataComponent

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

Specified by:

isModifiable in interface DataComponent

Returns:

true when component is modifiable

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

setReferenceLocator

public void setReferenceLocator(EntityReferenceLocator locator)

Description copied from interface: ReferenceComponent

Establishes the reference locator that will be used by component. This method is automatically called by Form when it is being loaded.

Specified by:

setReferenceLocator in interface ReferenceComponent

Parameters:

locator - a reference locator to set in component

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 Column

setParentFrame

public void setParentFrame(Frame marco)

Description copied from interface: OpenDialog

This method is called from Form for each component that implements this interface. It fixes the parent frame for element. This frame is needed to open the modal dialog.

Specified by:

setParentFrame in interface OpenDialog

Parameters:

marco - the frame

getLabelComponentText

public String getLabelComponentText()

Description copied from interface: DataComponent

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

Specified by:

getLabelComponentText in interface DataComponent

Returns:

the label text

setParentForm

public void setParentForm(Form f)

Description copied from interface: AccessForm

Method declaration to set the form that contains the component. This method must be called automatically during the form building.

Specified by:

setParentForm in interface AccessForm

Overrides:

setParentForm in class Column

Parameters:

f - the form reference

checkComponentListOK

protected void checkComponentListOK()

Creates the form component list manages by this object. All list component are set no modifiables. So, form is not allowed to delete/activate it.

setCode

public void setCode(Object code)

This method is similar to introduce the code into the field from user interface. It queries to entity and fills the fields.

Parameters:

code - the object to set code