com.ontimize.gui.container
Class CollapsibleGroup

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.ontimize.util.swing.JCollapsibleGroupPanel.JCollapsibleGroup
                      com.ontimize.gui.container.CollapsibleGroup

All Implemented Interfaces:

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

public class CollapsibleGroup

extends JCollapsibleGroupPanel.JCollapsibleGroup

implements FormComponent, IdentifiedElement, AccessForm

This class implements a deployable panel into a CollapsibleGroupPanel container. Each CollapsibleGroup is composed by a Header and a Body. The Header is the visible part when the component is collapsed and the one that contains the title of the group and the responsible of the motion of the component. The body is the motion part of the component and the one that functions as a container of elements.

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

static class

CollapsibleGroup.CollapsibleGroupHeader

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 java.awt.Image	backgroundImage A reference to specify a background image in the column.
protected java.awt.Paint	backgroundPaint A reference to background paint.
static java.lang.String	FG_COLOR Attribute to define foreground color of the Collapsible Group Header on collapsed state.
static java.lang.String	FG_OPEN_COLOR Attribute to define foreground color of the Collapsible Group Header on deployed state.
static java.lang.String	FG_PRESSED_COLOR Attribute to define foreground color of the Collapsible Group Header on mouse pressed state.
static java.lang.String	FG_ROLLOVER_COLOR Attribute to define foreground color of the Collapsible Group Header on mouse rollover state.
static java.lang.String	FG_SHADOW_COLOR Attribute to define foreground shadow color of the Collapsible Group Header on collapsed state.
static java.lang.String	FG_SHADOW_OPEN_COLOR Attribute to define foreground shadow color of the Collapsible Group Header on deployed state.
static java.lang.String	FG_SHADOW_PRESSED_COLOR Attribute to define foreground shadow color of the Collapsible Group Header on mouse pressed state.
static java.lang.String	FG_SHADOW_ROLLOVER_COLOR Attribute to define foreground shadow color of the Collapsible Group Header on mouse rollover state.
static java.lang.String	HEADER_BG_COLOR Attribute to define background color of the Collapsible Group Header on collapsed state.
static java.lang.String	HEADER_BG_IMAGE Attribute to define background image of the Collapsible Group Header.
static java.lang.String	HEADER_BG_OPEN_COLOR Attribute to define background color of the Collapsible Group Header on deployed state.
static java.lang.String	HEADER_BG_OPEN_IMAGE Attribute to define background color of the Collapsible Group Header on deployed state.
static java.lang.String	HEADER_BG_ROLLOVER_COLOR Attribute to define background color of the Collapsible Group Header on mouse rollover state.
static java.lang.String	HEADER_BG_ROLLOVER_IMAGE Attribute to define background image of the Collapsible Group Header on mouse rollover state.
static java.lang.String	ICON Attribute to define the icon on collapsed state of the Collapsible Group Header.
static java.lang.String	OPEN_ICON Attribute to define the icon on deployed state of the Collapsible Group Header.
protected Form	parentForm A reference to parent Form.
protected boolean	restricted The restricted condition.
static java.lang.String	ROLLOVER_ICON Attribute to define the icon on mouse rollover state of the Collapsible Group Header.
protected java.awt.TexturePaint	texturePaint A reference to specify a texture paint.
protected java.lang.String	title The Collapsible Group title.
protected FormPermission	visiblePermission The visible permission reference.

Fields inherited from class com.ontimize.util.swing.JCollapsibleGroupPanel.JCollapsibleGroup

attr, body, collapsed, constraints, filler, header, scroll

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

CollapsibleGroup(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)
void	addMouseListener(java.awt.event.MouseListener mouseListener)
protected boolean	checkVisiblePermission() Checks the visible permissions.
JCollapsibleGroupPanel.JCollapsibleGroupHeader	createCollapsibleGroupHeader(java.lang.String title)
java.lang.Object	getAttribute() Gets the object attribute.
protected java.awt.Color	getColor(java.lang.String strColor, java.lang.String parameterName) This method returns a Color from the specified String with the color.
java.lang.Object	getConstraints(java.awt.LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
protected java.awt.Image	getImage(java.lang.String imageURL) This method returns an Image from the specified path of the image.
java.awt.LayoutManager	getLayout()
java.util.Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(java.util.Hashtable parameters) Initializes parameters.
void	initPermissions()
boolean	isRestricted()
protected void	paintComponent(java.awt.Graphics g)
void	setBackgroundImage(java.awt.Image im) Sets a background image in Collapsible Group.
void	setBackgroundPaint(java.awt.Paint p) Sets the background paint parameter and repaints the Collapsible Group.
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 form) Method declaration to set the form that contains the component.
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 com.ontimize.util.swing.JCollapsibleGroupPanel.JCollapsibleGroup

addHeaderMouserListener, changeDeploy, getCollapsibleGroupHeader, getGridBagConstraints, getPreferredSize, getTitle, isCollapsed, processGridBagConstraints, removeHeaderMouserListener, setBackground, setCollapsed, setGridBagConstraints, setHeader, setOpaque

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, 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, 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, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, 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, 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

ICON

public static java.lang.String ICON

Attribute to define the icon on collapsed state of the Collapsible Group Header.

OPEN_ICON

public static java.lang.String OPEN_ICON

Attribute to define the icon on deployed state of the Collapsible Group Header.

ROLLOVER_ICON

public static java.lang.String ROLLOVER_ICON

Attribute to define the icon on mouse rollover state of the Collapsible Group Header.

HEADER_BG_COLOR

public static java.lang.String HEADER_BG_COLOR

Attribute to define background color of the Collapsible Group Header on collapsed state.

HEADER_BG_ROLLOVER_COLOR

public static java.lang.String HEADER_BG_ROLLOVER_COLOR

Attribute to define background color of the Collapsible Group Header on mouse rollover state.

HEADER_BG_OPEN_COLOR

public static java.lang.String HEADER_BG_OPEN_COLOR

Attribute to define background color of the Collapsible Group Header on deployed state.

HEADER_BG_IMAGE

public static java.lang.String HEADER_BG_IMAGE

Attribute to define background image of the Collapsible Group Header.

HEADER_BG_ROLLOVER_IMAGE

public static java.lang.String HEADER_BG_ROLLOVER_IMAGE

Attribute to define background image of the Collapsible Group Header on mouse rollover state.

HEADER_BG_OPEN_IMAGE

public static java.lang.String HEADER_BG_OPEN_IMAGE

Attribute to define background color of the Collapsible Group Header on deployed state.

FG_COLOR

public static java.lang.String FG_COLOR

Attribute to define foreground color of the Collapsible Group Header on collapsed state.

FG_ROLLOVER_COLOR

public static java.lang.String FG_ROLLOVER_COLOR

Attribute to define foreground color of the Collapsible Group Header on mouse rollover state.

FG_PRESSED_COLOR

public static java.lang.String FG_PRESSED_COLOR

Attribute to define foreground color of the Collapsible Group Header on mouse pressed state.

FG_OPEN_COLOR

public static java.lang.String FG_OPEN_COLOR

Attribute to define foreground color of the Collapsible Group Header on deployed state.

FG_SHADOW_COLOR

public static java.lang.String FG_SHADOW_COLOR

Attribute to define foreground shadow color of the Collapsible Group Header on collapsed state.

FG_SHADOW_ROLLOVER_COLOR

public static java.lang.String FG_SHADOW_ROLLOVER_COLOR

Attribute to define foreground shadow color of the Collapsible Group Header on mouse rollover state.

FG_SHADOW_PRESSED_COLOR

public static java.lang.String FG_SHADOW_PRESSED_COLOR

Attribute to define foreground shadow color of the Collapsible Group Header on mouse pressed state.

FG_SHADOW_OPEN_COLOR

public static java.lang.String FG_SHADOW_OPEN_COLOR

Attribute to define foreground shadow color of the Collapsible Group Header on deployed state.

backgroundPaint

protected java.awt.Paint backgroundPaint

A reference to background paint. By default, null.

backgroundImage

protected java.awt.Image backgroundImage

A reference to specify a background image in the column.

texturePaint

protected java.awt.TexturePaint texturePaint

A reference to specify a texture paint.

title

protected java.lang.String title

The Collapsible Group title. By default, "Group"

attribute

protected java.lang.Object attribute

The attribute reference. By default, null.

visiblePermission

protected FormPermission visiblePermission

The visible permission reference. By default, null.

restricted

protected boolean restricted

The restricted condition. By default, false.

parentForm

protected Form parentForm

A reference to parent Form.

Constructor Detail

CollapsibleGroup

public CollapsibleGroup(java.util.Hashtable parameters)

Init parameters and sets scroll and margins.

Parameters:

parameters - the hashtable with parameters

Method Detail

setParentForm

public void setParentForm(Form form)

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:

form - the form reference

getLayout

public java.awt.LayoutManager getLayout()

init

public void init(java.util.Hashtable parameters)

Initializes parameters.

attribute	values	default	required	meaning
attr			no (only required when title is not specified)	Indicates the component attribute.
title			no (only required when attr is not specified)	The title for component.
opaque	yes/no	yes	no	Specifies if the component must be opaque or not.
startshowed	yes/no	no	no	Specifies whether the Collapsible Group starts collpased or not.
bgcolor	A color		no	Specifies the Collapsible Group background color.
bgimage			no	The path to background image.
bgpaint			no	Paint value to use in this container. See ColorConstants.paintNameToPaint(String)
textureimage			no	Path to source icon to extract a image and create a TexturePaint
icon			no	The icon for Collapsible Group Header when is collapsed. If 'openicon' and 'rollovericon' are not specified this icon is the default icon.
openicon			no	The icon for Collapsible Group Header when is deployed.
rollovericon			no	The icon for Collapsible Group Header when is on mouse rollover event.
headerbgcolor	A color		no	Specifies the Collapsible Group Header background color when is collapsed.
headerbgrollovercolor	A color		no	Specifies the Collapsible Group Header background color when is on mouse rollover event.
headerbgopencolor	A color		no	Specifies the Collapsible Group Header background color when is deployed.
headerbgimage	A color		no	Specifies the path to background image of Collapsible Group Header when is collapsed.
headerbgrolloverimage	A color		no	Specifies the path to background image of Collapsible Group Header background when is on mouse rollover event.
headerbgopenimage	A color		no	Specifies the path to background image of Collapsible Group Header background when is deployed.
font	A string like : 'Arial-BOLD-18' (See #Font.decode())	The default font for system	no	Font for Collapsible Group Header text.
fontcolor		black	no	The font color of Collapsible Group Header text when is collapsed.
fontrollovercolor		black	no	The font color of Collapsible Group Header text when is on mouse rollover event.
fontpressedcolor		black	no	The font color of Collapsible Group Header text when is on mouse pressed event.
fontopencolor		black	no	The font color of Collapsible Group Header text when is deployed.
fontshadowcolor		white	no	The font shadow color of Collapsible Group Header text when is collapsed.
fontshadowrollovercolor		white	no	The font shadow color of Collapsible Group Header text when is on mouse rollover event.
fontshadowpressedcolor		white	no	The font shadow color of Collapsible Group Header text when is on mouse pressed event.
fontshadowopencolor		white	no	The font shadow color of Collapsible Group Header text when is deployed.

Specified by:

init in interface FormComponent

Parameters:

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

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

getColor

protected java.awt.Color getColor(java.lang.String strColor,
                                  java.lang.String parameterName)

This method returns a Color from the specified String with the color.

Parameters:

strColor - String with the value of the color.

parameterName - Parameter name for which is the specified color. In case of bad parsing, an error is printed with the parameter name.

Returns:

a Color.

getImage

protected java.awt.Image getImage(java.lang.String imageURL)

This method returns an Image from the specified path of the image.

Parameters:

imageURL - The path of the image.

Returns:

an Image.

paintComponent

protected void paintComponent(java.awt.Graphics g)

setBackgroundPaint

public void setBackgroundPaint(java.awt.Paint p)

Sets the background paint parameter and repaints the Collapsible Group.

Parameters:

p - The background paint configuration

setBackgroundImage

public void setBackgroundImage(java.awt.Image im)

Sets a background image in Collapsible Group.

Parameters:

im - The awt image to set in background image

See Also:

Image

createCollapsibleGroupHeader

public JCollapsibleGroupPanel.JCollapsibleGroupHeader createCollapsibleGroupHeader(java.lang.String title)

Overrides:

createCollapsibleGroupHeader in class JCollapsibleGroupPanel.JCollapsibleGroup

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)

Overrides:

add in class JCollapsibleGroupPanel.JCollapsibleGroup

add

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

Overrides:

add in class JCollapsibleGroupPanel.JCollapsibleGroup

add

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

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

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

addMouseListener

public void addMouseListener(java.awt.event.MouseListener mouseListener)

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

Checks the visible permissions.

Returns:

the visibility condition

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement