com.ontimize.gui.container

Class ExtendedMultiReference

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.container.ExtendedMultiReference

All Implemented Interfaces:

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

public class ExtendedMultiReference
extends JPanel
implements FormComponent, AccessForm, ReferenceComponent, OpenDialog, Internationalization, CreateForms, IdentifiedElement

This class implements a ReferenceExtDataField similar component. It supports grouping many data components (like an entity) and fills in a query. The field has an attribute, a code and columns and fields whose attributes are correspondent to these columns will be asked to associated entity.

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 int	alignment The reference to alignment.
protected Vector	askedAttributes The reference to asked attributes.
protected String	attribute The reference to attributes.
protected String	code The reference to code.
protected String	defaultIcon The reference to default icon path.
protected JButton	deleteButton The reference to delete button.
protected FormPermission	enabledPermission The reference to enabled permission.
protected String	entity The reference to entity.
protected Vector	fieldAttributes
protected FocusAdapter	focusListener An instance of a focus listener.
protected String	icon The reference to icon.
protected EntityReferenceLocator	locator The reference to locator.
protected JButton	okButton The reference to ok button.
protected Form	parentForm The reference to parent form.
protected Frame	parentFrame The reference to parent frame.
protected String	parentKey The reference to parentkey.
protected JButton	queryButton The reference to query button.
protected ResourceBundle	resources The reference to bundle resources.
protected boolean	restricted The restricted condition.
protected boolean	show The condition to show.
protected Table	t The reference to table.
protected JDialog	tableWindow The reference to table window.
protected String	text The reference to text.
protected String	tip The reference to tip.
protected FormPermission	visiblePermission The reference to visible permission.
protected String	windowTitle The reference to window title.

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.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
ExtendedMultiReference(Hashtable parameters) The class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkEnabledPermission() Checks enabled permission.
protected boolean	checkVisiblePermission() Checks visible permission.
protected void	fillDataFields(Hashtable result) Fills the data fields with Hashtable parameter.
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(Hashtable parameters) Inits parameters.
void	initPermissions()
boolean	isHidden() The complementary show condition.
boolean	isRestricted()
protected EntityResult	queryEntity(Object codeValue) Creates a query by code for the defined entity.
void	setCode(Object codeValue) It is equals to insert a code in field.
void	setComponentLocale(Locale l)
protected void	setComponentValue(Object attribute, Object value) Sets the value to component.
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setFormBuilder(FormBuilder builder)
void	setParentForm(Form f) Method declaration to set the form that contains the component.
void	setParentFrame(Frame parentFrame) 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	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setVisible(boolean vis) Description method to set visible or not the component according the boolean condition in parameter.

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, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, 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, 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, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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, 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

isEnabled

Field Detail

show

protected boolean show

The condition to show.

entity

protected String entity

The reference to entity. By default, null.

code

protected String code

The reference to code. By default, null.

parentKey

protected String parentKey

The reference to parentkey. By default, null.

tableWindow

protected JDialog tableWindow

The reference to table window. By default, null.

okButton

protected JButton okButton

The reference to ok button. By default, null.

t

protected Table t

The reference to table. By default, null.

locator

protected EntityReferenceLocator locator

The reference to locator. By default, null.

alignment

protected int alignment

The reference to alignment. By default, north.

windowTitle

protected String windowTitle

The reference to window title. By default, null.

text

protected String text

The reference to text. By default, null.

queryButton

protected JButton queryButton

The reference to query button. By default, null.

deleteButton

protected JButton deleteButton

The reference to delete button. By default, null.

fieldAttributes

protected Vector fieldAttributes

askedAttributes

protected Vector askedAttributes

The reference to asked attributes. By default, null.

attribute

protected String attribute

The reference to attributes. By default, null.

tip

protected String tip

The reference to tip. By default, null.

icon

protected String icon

The reference to icon. By default, null.

defaultIcon

protected String defaultIcon

The reference to default icon path.

parentForm

protected Form parentForm

The reference to parent form. By default, null.

parentFrame

protected Frame parentFrame

The reference to parent frame. By default, null.

resources

protected ResourceBundle resources

The reference to bundle resources. By default, null.

visiblePermission

protected FormPermission visiblePermission

The reference to visible permission. By default, null.

enabledPermission

protected FormPermission enabledPermission

The reference to enabled permission. By default, null.

focusListener

protected FocusAdapter focusListener

An instance of a focus listener.

restricted

protected boolean restricted

The restricted condition. By default, false.

Constructor Detail

ExtendedMultiReference

public ExtendedMultiReference(Hashtable parameters)

The class constructor. Calls to super() and inits parameters.

Parameters:

parameters - the Hashtable with parameters

Method Detail

init

public void init(Hashtable parameters)

Inits parameters.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
attr			yes	The field attribute.
align	right/left	north	no	The alignment for component.
entity			yes	Associated entity.
cod			no	The code name associated to field.
attrs	attr1;attr2;...;attrn	cols	no	Attributes to fill after query operation.
icon			no	Icon for query button.
text			no	The text for query button.
tip			no	The tip for query button.
descriptioncols	dcol1;dcol2;...;dcoln	yes	no	Visible table columns in text field. By default, it is the parameter value of visiblecols in table.

Valid Table parameters:

attribute	values	default	required	meaning
key		cod	no	The Table key.
parentkey or parentkeys	pk1;pk2;...;pkn		yes	The parentkey or parentkeys to filter.
cols	cols1;cols2;...;colsn		yes	Columns associated to the code. It forms the description field.
form			no	The form that is opened in detail. On init, update mode will be its state.
controls	yes/no	yes	no	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.
otherkeys	ok1;ok2;...;okn		no	The other keys.

setComponentValue

protected void setComponentValue(Object attribute,
                     Object value)

Sets the value to component.

Parameters:

attribute - the attribute to set

value - the value to set to the attribute

isHidden

public boolean isHidden()

The complementary show condition.

Returns:

the boolean condition

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

setParentFrame

public void setParentFrame(Frame parentFrame)

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:

parentFrame - the frame

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

Parameters:

f - the form reference

setCode

public void setCode(Object codeValue)

It is equals to insert a code in field.

Parameters:

codeValue - the code to set

fillDataFields

protected void fillDataFields(Hashtable result)

Fills the data fields with Hashtable parameter.

Parameters:

result - the Hashtable with data.

queryEntity

protected EntityResult queryEntity(Object codeValue)

Creates a query by code for the defined entity.

Parameters:

codeValue - the code value

Returns:

the result

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

Parameters:

resources - the new language bundle.

getConstraints

public Object getConstraints(LayoutManager parentLayout)

Description copied from interface: FormComponent

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

Specified by:

getConstraints in interface FormComponent

Parameters:

parentLayout - the parent container reference

Returns:

the constraints for the component

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

Returns:

all the texts in the element suitable for being translated.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

setFormBuilder

public void setFormBuilder(FormBuilder builder)

Specified by:

setFormBuilder in interface CreateForms

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 JComponent

Parameters:

enabled - the enabled condition

setVisible

public void setVisible(boolean vis)

Description copied from interface: FormComponent

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

Specified by:

setVisible in interface FormComponent

Overrides:

setVisible in class JComponent

Parameters:

vis - the visibility condition

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

Checks visible permission.

Returns:

the visibility condition

checkEnabledPermission

protected boolean checkEnabledPermission()

Checks enabled permission.

Returns:

the enabled condition

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement