com.ontimize.gui

Class EntityResultViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.EntityResultViewer

All Implemented Interfaces:

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

public class EntityResultViewer
extends JPanel
implements DataComponent, AccessForm

This class implements a table viewer for an Entity result.

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 Object	attribute The reference to attribute.
protected BooleanCellRenderer	booleanRenderer A reference to a boolean cell renderer.
protected JPanel	controlPanel An instance of a control panel.
protected String	copyClipboardKey The key to copy to clipboard the tip.
protected JMenuItem	copyMenu A instance of the copy menu item.
protected DateCellRenderer	dateRenderer A reference to date renderer.
protected FormPermission	enabledPermission The enabled permission reference.
protected HeadCellRenderer	headerRenderer A reference to a header renderer.
protected ExtImageCellRenderer	imageRenderer A reference to an image renderer.
protected MouseAdapter	listMouseListener
protected ObjectCellRenderer	objectRenderer A reference to a object renderer.
protected Form	parentForm The reference to parent form.
protected ExtendedJPopupMenu	popup An instance of pop-up menu.
protected RealCellRenderer	realRenderer A reference to a real cell renderer.
protected JButton	reportButton A reference to report button.
protected ResourceBundle	resources A reference to resources file.
protected boolean	restricted
protected RowHeadCellRenderer	rowHeaderRenderer The reference to a row header renderer.
protected JTable	table An instance of the table.
protected FormPermission	visiblePermission The visible permission reference.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTableHeaderMouseListener(JTable table) Adds a default mouse listener to the table header and configures the table header rendering.
protected boolean	checkEnabledPermission() Checks the enabled permission.
protected boolean	checkVisiblePermission() Checks the visible permission condition.
protected void	copyClipboard() Implements the copy-to-clipboard operation.
void	deleteData() The method to delete data for component.
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
String	getExcelString() Gets the string with all table components (Columns separated by \t and rows by \n).
String	getLabelComponentText() Returns the label text component.
protected TableColumn	getResizingColumn(JTableHeader header, Point point, int columnIndex) Compares the point with the header of the column specified by the columnIndex.
int	getSQLDataType() Returns the sql data type according to java.sql.Types
protected TableModel	getTableModel(EntityResult res) Gets the table model for the entity result.
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.
void	initPermissions()
protected void	installPopup() Installs the copy to clipboard menu.
protected void	installReportButton() Installs the report button.
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.
boolean	isRestricted()
void	setComponentLocale(Locale l)
void	setEnabled(boolean e) Description method to set enabled or not the component according the boolean condition in parameter.
void	setModifiable(boolean modifiable) Establishes the modifiable condition for a component.
void	setModified(boolean modifiable) Empty method.
void	setParentForm(Form f) Method declaration to set the form that contains the component.
protected void	setRenderers() Creates instances of all defined renderer and sets them to the table.
void	setRequired(boolean required) Sets required a component according to condition.
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setValue(Object value) Sets the value for component.
void	showCustomReportsWindow() Shows the report window.

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, setVisible, 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, setVisible

Field Detail

table

protected JTable table

An instance of the table.

attribute

protected Object attribute

The reference to attribute. By default, null.

visiblePermission

protected FormPermission visiblePermission

The visible permission reference. By default, null.

enabledPermission

protected FormPermission enabledPermission

The enabled permission reference. By default, null.

parentForm

protected Form parentForm

The reference to parent form. By default, null.

dateRenderer

protected DateCellRenderer dateRenderer

A reference to date renderer. By default, null.

rowHeaderRenderer

protected RowHeadCellRenderer rowHeaderRenderer

The reference to a row header renderer. By default, null.

booleanRenderer

protected BooleanCellRenderer booleanRenderer

A reference to a boolean cell renderer. By default, null.

realRenderer

protected RealCellRenderer realRenderer

A reference to a real cell renderer. By default, null.

objectRenderer

protected ObjectCellRenderer objectRenderer

A reference to a object renderer. By default, null.

imageRenderer

protected ExtImageCellRenderer imageRenderer

A reference to an image renderer. By default, null.

headerRenderer

protected HeadCellRenderer headerRenderer

A reference to a header renderer. By default, null.

popup

protected ExtendedJPopupMenu popup

An instance of pop-up menu.

copyClipboardKey

protected String copyClipboardKey

The key to copy to clipboard the tip.

copyMenu

protected JMenuItem copyMenu

A instance of the copy menu item.

controlPanel

protected JPanel controlPanel

An instance of a control panel.

reportButton

protected JButton reportButton

A reference to report button. By default, null.

resources

protected ResourceBundle resources

A reference to resources file. By default, null.

restricted

protected boolean restricted

listMouseListener

protected MouseAdapter listMouseListener

Constructor Detail

EntityResultViewer

public EntityResultViewer(Hashtable parameters)

The class constructor. Calls to super(), initializes parameters, sets renderer and installs pop-up and report button.

Parameters:

parameters - the Hashtable with parameters

Method Detail

installReportButton

protected void installReportButton()

Installs the report button.

installPopup

protected void installPopup()

Installs the copy to clipboard menu.

copyClipboard

protected void copyClipboard()

Implements the copy-to-clipboard operation.

getExcelString

public String getExcelString()

Gets the string with all table components (Columns separated by \t and rows by \n).

Returns:

the string data

setRenderers

protected void setRenderers()

Creates instances of all defined renderer and sets them to the table.

init

public void init(Hashtable parameters)

Initializes parameters.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters.

attribute	values	default	required	meaning
attr			no	The attribute for 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

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

Checks the visible permission condition.

Returns:

the visible permission condition

checkEnabledPermission

protected boolean checkEnabledPermission()

Checks the enabled permission.

Returns:

the enabled permission

getTableModel

protected TableModel getTableModel(EntityResult res)

Gets the table model for the entity result.

Parameters:

res - the entity result

Returns:

the table model

addTableHeaderMouseListener

public void addTableHeaderMouseListener(JTable table)

Adds a default mouse listener to the table header and configures the table header rendering. Controls all the click dependent behaviour of the table header.

Parameters:

table - the table which header will have the listener

getResizingColumn

protected TableColumn getResizingColumn(JTableHeader header,
                            Point point,
                            int columnIndex)

Compares the point with the header of the column specified by the columnIndex. If the point corresponds to the header, the method returns the related TableColumn.

Parameters:

header - the table header

point - a point coming from a mouse event

columnIndex - the columnIndex to compare return the TableColumn corresponding to the columnIndex in case the mouse event was performed into the column header; null otherwise

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.

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.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

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

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.

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

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

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

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

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

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

setModifiable

public void setModifiable(boolean modifiable)

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:

modifiable - the boolean condition

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

setModified

public void setModified(boolean modifiable)

Empty method.

Parameters:

modifiable - the modified condition

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

setEnabled

public void setEnabled(boolean e)

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:

e - the enabled condition

showCustomReportsWindow

public void showCustomReportsWindow()

Shows the report window.

See Also:

ReportUtils.showDefaultReportDialog(Component)