com.ontimize.gui.container

Class CollapsibleGroupPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.util.swing.JCollapsibleGroupPanel

com.ontimize.gui.container.CollapsibleGroupPanel

All Implemented Interfaces:

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

public class CollapsibleGroupPanel
extends JCollapsibleGroupPanel
implements FormComponent, ReferenceComponent, IdentifiedElement, AccessForm

This class implements a component that lets the user storing different elements inside it. Between these elements it can be stores CollapsiblGroup

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ontimize.util.swing.JCollapsibleGroupPanel

JCollapsibleGroupPanel.CollapseAction, JCollapsibleGroupPanel.JCollapsibleGroup, JCollapsibleGroupPanel.JCollapsibleGroupHeader

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 Image	backgroundImage A reference to specify a background image in the column.
protected Paint	backgroundPaint A reference to background paint.
static String	BGCOLOR Attribute to define background color of the Collapsible Group.
static String	BGIMAGE Attribute to define background image of the Collapsible Group.
static String	BGPAINT Attribute to define background paint of the Collapsible Group.
protected int	borderPosition The border position.
protected EntityReferenceLocator	locator The reference to locator.
protected Form	parentForm The reference to parent form for component.
protected ResourceBundle	resources
protected boolean	restricted The restricted condition.
static String	TEXTUREIMAGE Attribute to define background texture image of the Collapsible Group.
protected TexturePaint	texturePaint A reference to specify a texture paint.
protected String	title The title for the Collapsible Group Panel border.
protected TitledBorder	titledBorder Indicates a special title with arbitrary border with the addition of a String title in a specified position and justification.
protected FormPermission	visiblePermission The reference for visible permission.

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

animated, cycleStart, deployTime, fillerComponent, headerMouseListener, initStateCollapsed, onlyonedeployed, target, timer

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component c, Object constraints)
protected boolean	checkVisiblePermission() Checks the visible permission.
protected JPanel	createFillerComponent() This method creates the filler panel that is placed under all components of the Collpasible Group Panel.
Object	getAttribute() Gets the object attribute.
protected Color	getColor(String strColor, String parameterName) This method returns a Color from the specified String with the color.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
protected Image	getImage(String imageURL) This method returns an Image from the specified path of the image.
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(Hashtable parameters) Inits the parameters.
void	initPermissions()
boolean	isRestricted()
void	setBackgroundImage(Image im) Sets a background image in Collapsible Group Panel.
void	setBackgroundPaint(Paint p) Sets the background paint parameter and repaints the Collapsible Group Panel.
void	setComponentLocale(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(ResourceBundle resource) Sets the language resource bundle.
void	setVisible(boolean visible) Description method to set visible or not the component according the boolean condition in parameter.

Methods inherited from class com.ontimize.util.swing.JCollapsibleGroupPanel

add, add, addGroupPanel, getGroupPanels, isAnimated, isOnlyonedeployed, removeGroupPanel, revalidate, setAnimated, setOnlyonedeployed

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

BGCOLOR

public static String BGCOLOR

Attribute to define background color of the Collapsible Group.

BGPAINT

public static String BGPAINT

Attribute to define background paint of the Collapsible Group.

BGIMAGE

public static String BGIMAGE

Attribute to define background image of the Collapsible Group.

TEXTUREIMAGE

public static String TEXTUREIMAGE

Attribute to define background texture image of the Collapsible Group.

backgroundPaint

protected Paint backgroundPaint

A reference to background paint. By default, null.

backgroundImage

protected Image backgroundImage

A reference to specify a background image in the column.

texturePaint

protected TexturePaint texturePaint

A reference to specify a texture paint.

attribute

protected Object attribute

The reference to attribute. By default, null.

title

protected String title

The title for the Collapsible Group Panel border. By default is "null".

titledBorder

protected TitledBorder titledBorder

Indicates a special title with arbitrary border with the addition of a String title in a specified position and justification.

borderPosition

protected int borderPosition

The border position.

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.

restricted

protected boolean restricted

The restricted condition. By default, false.

resources

protected ResourceBundle resources

Constructor Detail

CollapsibleGroupPanel

public CollapsibleGroupPanel(Hashtable parameters)

The class constructor. Inits parameters.

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(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 Collapsible Group Panel.
opaque	yes/no	yes	no	Specifies if the component must be opaque or not.
anim	yes/no	no	no	Sets the animation enabled/disabled
startshowed	yes/no	no	no	Specifies whether the Collapsible Group Panel starts collpased or not.If true all CollapsibleGroups contained on it are forced to be collpased, if not each Collpasible Group takes its own 'startshowed' parameter.
onlyonedeployed	yes/no	no	no	Specifies if just one Collapsible Group can be opened or it can be opened more than one. By default it is allowed to deploy more than one Collpasible Group.
time		200	no	Sets deploying/undeploying duration in milliseconds
margin			no	Indicates the column margin.
title			no	The Collapsible Group Panel title.
border	none/lowered/raised/bevellowered/bevelraised	none	no	The border definition.
titleposition	abovetop/top/belowtop/abovebottom/bottom/belowbottom		no	The title-position of the titled border..
bgcolor			no	The background color. A possible color for ColorConstants or a RGB value like: '150;230;23'
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

getColor

protected Color getColor(String strColor,
             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 Image getImage(String imageURL)

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

Parameters:

imageURL - The path of the image.

Returns:

an Image.

createFillerComponent

protected JPanel createFillerComponent()

This method creates the filler panel that is placed under all components of the Collpasible Group Panel.

Overrides:

createFillerComponent in class JCollapsibleGroupPanel

setBackgroundPaint

public void setBackgroundPaint(Paint p)

Sets the background paint parameter and repaints the Collapsible Group Panel.

Parameters:

p - The background paint configuration

setBackgroundImage

public void setBackgroundImage(Image im)

Sets a background image in Collapsible Group Panel.

Parameters:

im - The awt image to set in background image

See Also:

Image

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

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

setResourceBundle

public void setResourceBundle(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 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

add

public void add(Component c,
       Object constraints)

Overrides:

add in class JCollapsibleGroupPanel

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

Overrides:

setVisible in class JComponent

Parameters:

visible - the visibility condition

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

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

Checks the visible permission.

Returns:

the condition about visibility permission

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