Ontimize 5.2072EN

com.ontimize.gui.container
Class TabPanel

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JTabbedPane
                  extended bycom.ontimize.gui.container.TabPanel
All Implemented Interfaces:
AccessForm, javax.accessibility.Accessible, javax.swing.event.ChangeListener, java.util.EventListener, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, ReferenceComponent, SecureElement, java.io.Serializable, javax.swing.SwingConstants

public class TabPanel
extends javax.swing.JTabbedPane
implements FormComponent, ReferenceComponent, IdentifiedElement, AccessForm, javax.swing.event.ChangeListener

This class implements a component that lets the user switch between a group of components by clicking on a tab.

Author:
Imatia Innovation
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JTabbedPane
javax.swing.JTabbedPane.AccessibleJTabbedPane, javax.swing.JTabbedPane.ModelListener
 
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 reference to attribute.
protected  FormPermission enabledPermission
          The reference for enabled permission.
protected  EntityReferenceLocator locator
          The reference to locator.
protected  Form parentForm
          The reference to parent form for component.
protected  java.util.ResourceBundle resources
           
protected  boolean restricted
          The restricted condition.
protected  java.util.Vector tabs
          The instance of vector with tabs.
protected  FormPermission visiblePermission
          The reference for visible permission.
 
Fields inherited from class javax.swing.JTabbedPane
changeEvent, changeListener, model, SCROLL_TAB_LAYOUT, tabPlacement, WRAP_TAB_LAYOUT
 
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
TabPanel(java.util.Hashtable parameters)
          The class constructor.
 
Method Summary
 void add(java.awt.Component c, java.lang.Object constraints)
           
protected  boolean checkEnabledPermission()
          Checks enabled permission.
protected  boolean checkVisiblePermission()
          Checks the visible permission.
 void clearNotQueriedTabs()
           
 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.
 java.util.Vector getNotQueriedDataFieldAttributes()
          Gets no queried data field attributes.
 java.lang.String getTabVisible()
          Gets the tab visible.
 java.util.Vector getTextsToTranslate()
          Returns all the texts in the element suitable for being translated.
 void hideAllTabs()
          Hides all tabs.
 void hideTabs(java.lang.String title)
          Hides the tab according to the title.
 void init(java.util.Hashtable parameters)
          Inits the parameters.
 java.util.Vector initNotQueriedDataFieldAttributes()
          Inits no queried data field attributes.
 void initPermissions()
           
 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 setReferenceLocator(EntityReferenceLocator b)
          Establishes the reference locator that will be used by component.
 void setResourceBundle(java.util.ResourceBundle resource)
          Sets the language resource bundle.
 void setTabEnabled(int index, boolean enabled)
          Sets the tab enabled according to a index.
 void setTabEnabled(java.lang.String title, boolean enabled)
          Sets the tab enabled according to a title.
 void setTabVisible(int index)
          Sets the tab visible.
 void setTabVisible(java.lang.String title)
          Sets the tab visible.
 void setVisible(boolean visible)
          Description method to set visible or not the component according the boolean condition in parameter.
 void showAllTabs()
          Shows all tabs.
 void showTab(java.lang.String title)
          Shows the tab according to the title.
 void stateChanged(javax.swing.event.ChangeEvent e)
           
 
Methods inherited from class javax.swing.JTabbedPane
add, add, add, add, addChangeListener, addTab, addTab, addTab, createChangeListener, fireStateChanged, getAccessibleContext, getBackgroundAt, getBoundsAt, getChangeListeners, getComponentAt, getDisabledIconAt, getDisplayedMnemonicIndexAt, getForegroundAt, getIconAt, getMnemonicAt, getModel, getSelectedComponent, getSelectedIndex, getTabCount, getTabLayoutPolicy, getTabPlacement, getTabRunCount, getTitleAt, getToolTipText, getToolTipTextAt, getUI, getUIClassID, indexAtLocation, indexOfComponent, indexOfTab, indexOfTab, insertTab, isEnabledAt, paramString, remove, remove, removeAll, removeChangeListener, removeTabAt, setBackgroundAt, setComponentAt, setDisabledIconAt, setDisplayedMnemonicIndexAt, setEnabledAt, setForegroundAt, setIconAt, setMnemonicAt, setModel, setSelectedComponent, setSelectedIndex, setTabLayoutPolicy, setTabPlacement, setTitleAt, setToolTipTextAt, 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, 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
addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, 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

attribute

protected java.lang.Object attribute
The reference to attribute. By default, null.


tabs

protected java.util.Vector tabs
The instance of vector with tabs.


parentForm

protected Form parentForm
The reference to parent form for component. By default, null.


locator

protected EntityReferenceLocator locator
The reference to locator. By default, null.


visiblePermission

protected FormPermission visiblePermission
The reference for visible permission. By default, null.


enabledPermission

protected FormPermission enabledPermission
The reference for enabled permission. By default, null.


resources

protected java.util.ResourceBundle resources

restricted

protected boolean restricted
The restricted condition. By default, false.

Constructor Detail

TabPanel

public TabPanel(java.util.Hashtable parameters)
The class constructor. Inits parameters and adds ChangeListener.

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

init

public void init(java.util.Hashtable parameters)
Inits the parameters.

Specified by:
init in interface FormComponent
Parameters:
parameters - the hashtable with parameters

attribute values default required meaning
attr yes The attribute for tab panel.
opaque yes/no yes no Specifies if the component must be opaque or not.
bgcolor A color no Specifies the component background color.

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

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

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle resource)
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:
resource - the new language bundle.

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.

setComponentLocale

public void setComponentLocale(java.util.Locale l)
Specified by:
setComponentLocale in interface Internationalization

setTabEnabled

public void setTabEnabled(int index,
                          boolean enabled)
Sets the tab enabled according to a index.

Parameters:
index - the tab index
enabled - the condition to enable

setTabEnabled

public void setTabEnabled(java.lang.String title,
                          boolean enabled)
Sets the tab enabled according to a title.

Parameters:
title - the title
enabled - the condition to enable

setTabVisible

public void setTabVisible(java.lang.String title)
Sets the tab visible.

Parameters:
title - the title to find the tab

getTabVisible

public java.lang.String getTabVisible()
Gets the tab visible.

Returns:
the tab visible

setTabVisible

public void setTabVisible(int index)
Sets the tab visible.

Parameters:
index - the tab index

showAllTabs

public void showAllTabs()
Shows all tabs.


hideAllTabs

public void hideAllTabs()
Hides all tabs.


hideTabs

public void hideTabs(java.lang.String title)
Hides the tab according to the title.

Parameters:
title - the title

showTab

public void showTab(java.lang.String title)
Shows the tab according to the title.

Parameters:
title - the title

add

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

setVisible

public void setVisible(boolean visible)
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 permission.

Returns:
the condition about visibility permission

checkEnabledPermission

protected boolean checkEnabledPermission()
Checks enabled permission.

Returns:
the enabled permission condition

initNotQueriedDataFieldAttributes

public java.util.Vector initNotQueriedDataFieldAttributes()
Inits no queried data field attributes.

Returns:
the vector with no queried data field attributes

getNotQueriedDataFieldAttributes

public java.util.Vector getNotQueriedDataFieldAttributes()
Gets no queried data field attributes.

Returns:
the vector with no queried data field attributes

clearNotQueriedTabs

public void clearNotQueriedTabs()

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)
Specified by:
stateChanged in interface javax.swing.event.ChangeListener

setReferenceLocator

public void setReferenceLocator(EntityReferenceLocator b)
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:
b - a reference locator to set in component

isRestricted

public boolean isRestricted()
Specified by:
isRestricted in interface SecureElement

Ontimize