com.ontimize.gui.container
Class Tab

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ontimize.gui.container.Tab

All Implemented Interfaces:

AccessForm, javax.accessibility.Accessible, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, java.io.Serializable

public class Tab

extends javax.swing.JPanel

implements FormComponent, IdentifiedElement, AccessForm

This class implements a tab into a JPanel container.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.lang.Object	attribute The attribute reference.
protected javax.swing.JPanel	containPanel An instance of a panel.
static java.awt.Insets	DEFAULT_TAB_MARGIN The insets for default margin.
protected FormPermission	enabledPermission The enabled permission reference.
protected javax.swing.ImageIcon	icon The reference for an icon.
protected CustomColumnGridBagLayout	layout An instance of layout.
protected java.util.Vector	noRequiredTabFieldAttributesList The vector for not required tab field attribute list.
protected Form	parentForm A reference for the parent form.
static boolean	QUERY_IF_VISIBLE_DEFAULT_VALUE Condition about querying when it is visible the default value.
protected boolean	queryIfVisible The querying when it is visible the default value condition assignation.
protected boolean	restricted The restricted condition.
protected javax.swing.JScrollPane	scroll An instance of a scroll pane.
protected java.util.Vector	tabFieldAttributesList The tab field attribute vector.
protected java.lang.String	tipKey The reference to the tip key.
protected java.lang.String	title The tab title.
protected java.lang.String	titleKey The title key reference.
static boolean	USE_SCROLL Condition about scroll use.
protected boolean	useScroll The use scroll condition.
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.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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Tab(java.util.Hashtable parameters)
Init parameters and sets scroll and margins.

Method Summary

java.awt.Component	add(java.awt.Component c)
java.awt.Component	add(java.awt.Component c, int index)
void	add(java.awt.Component c, java.lang.Object constraints)
void	add(java.awt.Component c, java.lang.Object constraints, int index)
protected boolean	checkEnabledPermission() Checks the enabled permissions.
protected boolean	checkVisiblePermission() Checks the visible permissions.
java.lang.Object	getAttribute() Gets the object attribute.
java.lang.Object	getConstraints(java.awt.LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
protected void	getFieldAttributes(java.awt.Container c, java.util.Vector v) Gets the field attributes for a container.
javax.swing.Icon	getIcon() Gets the icon.
java.awt.LayoutManager	getLayout()
protected void	getNotRequiredFieldAttributes(java.awt.Container c, java.util.Vector v) Gets the not required field attributes.
java.util.Vector	getNotRequiredTabFieldAttributes() Gets not required tab field attributes.
java.util.Vector	getTabFieldAttributes() Gets the tab field attributes.
java.util.Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
java.lang.String	getTip() Gets the tip key.
java.lang.String	getTitleKey() Gets the title key.
void	init(java.util.Hashtable parameters) Initializes parameters.
void	initPermissions()
boolean	isQueryIfVisible() Returns the queryIfVisible condition.
boolean	isRestricted()
void	setComponentLocale(java.util.Locale l)
void	setEnabled(boolean enabled) Description method to set enabled or not the component according the boolean condition in parameter.
void	setParentForm(Form f) Method declaration to set the form that contains the component.
void	setQueryIfVisible(boolean query) Sets the query visibility condition.
void	setResourceBundle(java.util.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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, 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

DEFAULT_TAB_MARGIN

public static java.awt.Insets DEFAULT_TAB_MARGIN

The insets for default margin. By default, null.

QUERY_IF_VISIBLE_DEFAULT_VALUE

public static boolean QUERY_IF_VISIBLE_DEFAULT_VALUE

Condition about querying when it is visible the default value. By default, true.

USE_SCROLL

public static boolean USE_SCROLL

Condition about scroll use. By default, false.

title

protected java.lang.String title

The tab title. By default, "Tab"

titleKey

protected java.lang.String titleKey

The title key reference. By default, null.

scroll

protected javax.swing.JScrollPane scroll

An instance of a scroll pane.

containPanel

protected javax.swing.JPanel containPanel

An instance of a panel.

layout

protected CustomColumnGridBagLayout layout

An instance of layout.

icon

protected javax.swing.ImageIcon icon

The reference for an icon. By default, null.

attribute

protected java.lang.Object attribute

The attribute reference. 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

A reference for the parent form. By default, null.

tipKey

protected java.lang.String tipKey

The reference to the tip key. By default, null.

queryIfVisible

protected boolean queryIfVisible

The querying when it is visible the default value condition assignation.

useScroll

protected boolean useScroll

The use scroll condition.

tabFieldAttributesList

protected java.util.Vector tabFieldAttributesList

The tab field attribute vector. By defautl, null.

noRequiredTabFieldAttributesList

protected java.util.Vector noRequiredTabFieldAttributesList

The vector for not required tab field attribute list. By default, null.

restricted

protected boolean restricted

The restricted condition. By default, false.

Constructor Detail

Tab

public Tab(java.util.Hashtable parameters)

Init parameters and sets scroll and margins.

Parameters:

parameters - the hashtable with parameters

Method Detail

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

getConstraints

public java.lang.Object getConstraints(java.awt.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

getLayout

public java.awt.LayoutManager getLayout()

init

public void init(java.util.Hashtable parameters)

Initializes parameters.

attribute	values	default	required	meaning
title			no (only required when attr is not specified)	The title for component. It must be unique in the form.
icon			no	The icon panel.
attr			no (only required when title is not specified)	Indicates the component attribute.
queryifvisible	yes/no		yes	Specifies when data tab are queried. Only when is visible or in normal query mode.
tip		title	no	Specifies the tip for tab.
opaque	yes/no	yes	no	Specifies if the component must be opaque or not.
bgcolor	A color		no	Specifies the component background color.

Specified by:

init in interface FormComponent

Parameters:

parameters - the hashtable with pairs (Key,Value). For example:

Key	Value
align	center
attr	attribute
...	...

isQueryIfVisible

public boolean isQueryIfVisible()

Returns the queryIfVisible condition.

Returns:

the queryIfVisible condition

setQueryIfVisible

public void setQueryIfVisible(boolean query)

Sets the query visibility condition.

Parameters:

query - the query condition

getTitleKey

public java.lang.String getTitleKey()

Gets the title key.

Returns:

the title key

getTextsToTranslate

public java.util.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(java.util.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(java.util.Locale l)

Specified by:

setComponentLocale in interface Internationalization

add

public void add(java.awt.Component c,
                java.lang.Object constraints,
                int index)

add

public void add(java.awt.Component c,
                java.lang.Object constraints)

add

public java.awt.Component add(java.awt.Component c)

add

public java.awt.Component add(java.awt.Component c,
                              int index)

getIcon

public javax.swing.Icon getIcon()

Gets the icon.

Returns:

the icon reference

getTip

public java.lang.String getTip()

Gets the tip key.

Returns:

the tip

getAttribute

public java.lang.Object getAttribute()

Description copied from interface: IdentifiedElement

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

Specified by:

getAttribute in interface IdentifiedElement

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

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

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

Checks the visible permissions.

Returns:

the visibility condition

getTabFieldAttributes

public java.util.Vector getTabFieldAttributes()

Gets the tab field attributes.

Returns:

the vector with tab field attributes

getNotRequiredTabFieldAttributes

public java.util.Vector getNotRequiredTabFieldAttributes()

Gets not required tab field attributes.

Returns:

the vector with not required tab fields attributes

getFieldAttributes

protected void getFieldAttributes(java.awt.Container c,
                                  java.util.Vector v)

Gets the field attributes for a container.

Parameters:

c - the container where component is present

v - the vector to insert the field attributes

getNotRequiredFieldAttributes

protected void getNotRequiredFieldAttributes(java.awt.Container c,
                                             java.util.Vector v)

Gets the not required field attributes.

Parameters:

c - the container

v - the vector to get the not required field attributes

checkEnabledPermission

protected boolean checkEnabledPermission()

Checks the enabled permissions.

Returns:

the enabled permission condition

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement