com.ontimize.gui.container

Class CollapsiblePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.container.CollapsiblePanel

All Implemented Interfaces:

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

public class CollapsiblePanel
extends JPanel
implements FormComponent, IdentifiedElement, AccessForm, HasPreferenceComponent

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 boolean	animated
protected Object	attribute
protected String	baseTooltip
static String	borderClass
protected int	borderStyle
protected ResourceBundle	bundle
int	customHeight
int	customWidth
protected long	cycleStart
protected boolean	deployedState
protected int	deployTime
protected boolean	doFirstShow
protected boolean	expandHorizontal
protected boolean	expandLast
protected boolean	expandVertical
protected boolean	firstTime
static int	HORIZONTAL_ORIENTATION
static String	HORIZONTAL_ORIENTATION_VALUE
protected boolean	initiatedPreferences
protected JPanel	innerComponent
int	minHeight
int	minWidth
protected int	orientation
static String	ORIENTATION The key for orientation
protected Form	parentForm
static String	REVERSE_ICON
protected boolean	reverseIcons
protected Timer	timer
protected String	tiptext
protected String	title
static int	VERTICAL_ORIENTATION
static String	VERTICAL_ORIENTATION_VALUE
protected int	verticalAlignment
protected JViewport	viewPort

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
CollapsiblePanel(Hashtable parameters)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addImpl(Component comp, Object constraints, int index)
protected void	calculatedCustomHeight(float fraction, boolean animated)
protected void	calculatedCustomWidth(float fraction, boolean animated)
static boolean	computeIntersection(Rectangle dest, int rx, int ry, int rw, int rh)
protected void	createCustomBorder(String borderClassName, Hashtable parameters) Creates by reflection a specific border.
protected void	createDeployBorder(String title)
void	doActionDeploy(boolean animate)
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
LayoutManager	getLayout()
Dimension	getMaximumSize()
Dimension	getPreferredSize()
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
protected String	getUser() Gets user calling to Application.getReferenceLocator() and ReferenceLocator.getUser().
protected String	getVisiblePreferenceKey() Gets the preferred split position.
void	init(Hashtable parameters) Inits parameters.
void	initPermissions()
void	initPreferences(ApplicationPreferences ap, String user)
boolean	isDeploy()
boolean	isFirstShow()
boolean	isFirstTime()
boolean	isRestricted()
protected boolean	isVerticalOrientation()
void	paint(Graphics g)
protected void	saveVisiblePreference() Saves the visible preferences.
void	setBorder(Border border)
void	setComponentLocale(Locale l)
void	setDeploy(boolean deploy)
void	setFirstShow(boolean doFirstShow) Configure how the component must appear the first time (expanded or collapsed)
void	setLayout(LayoutManager mgr)
void	setOpaque(boolean isOpaque)
void	setParentForm(Form form) Method declaration to set the form that contains the component.
void	setPreferredSize(Dimension preferredSize)
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setTitle(String title)
void	validate()

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, getMinimumSize, getNextFocusableComponent, getPopupLocation, 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, 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, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, 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, transferFocusDownCycle, 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, setEnabled, setVisible

Field Detail

ORIENTATION

public static final String ORIENTATION

The key for orientation

See Also:

Constant Field Values

REVERSE_ICON

public static final String REVERSE_ICON

See Also:

Constant Field Values

HORIZONTAL_ORIENTATION_VALUE

public static final String HORIZONTAL_ORIENTATION_VALUE

See Also:

Constant Field Values

VERTICAL_ORIENTATION_VALUE

public static final String VERTICAL_ORIENTATION_VALUE

See Also:

Constant Field Values

HORIZONTAL_ORIENTATION

public static final int HORIZONTAL_ORIENTATION

See Also:

Constant Field Values

VERTICAL_ORIENTATION

public static final int VERTICAL_ORIENTATION

See Also:

Constant Field Values

borderClass

public static String borderClass

orientation

protected int orientation

innerComponent

protected JPanel innerComponent

viewPort

protected JViewport viewPort

deployedState

protected boolean deployedState

expandHorizontal

protected boolean expandHorizontal

expandVertical

protected boolean expandVertical

expandLast

protected boolean expandLast

verticalAlignment

protected int verticalAlignment

attribute

protected Object attribute

borderStyle

protected int borderStyle

title

protected String title

deployTime

protected int deployTime

animated

protected boolean animated

bundle

protected ResourceBundle bundle

timer

protected Timer timer

customHeight

public int customHeight

customWidth

public int customWidth

minHeight

public int minHeight

minWidth

public int minWidth

tiptext

protected String tiptext

doFirstShow

protected boolean doFirstShow

firstTime

protected boolean firstTime

baseTooltip

protected String baseTooltip

reverseIcons

protected boolean reverseIcons

initiatedPreferences

protected boolean initiatedPreferences

parentForm

protected Form parentForm

cycleStart

protected long cycleStart

Constructor Detail

CollapsiblePanel

public CollapsiblePanel(Hashtable parameters)

Method Detail

paint

public void paint(Graphics g)

Overrides:

paint in class JComponent

calculatedCustomHeight

protected void calculatedCustomHeight(float fraction,
                          boolean animated)

calculatedCustomWidth

protected void calculatedCustomWidth(float fraction,
                         boolean animated)

validate

public void validate()

Overrides:

validate in class Container

doActionDeploy

public void doActionDeploy(boolean animate)

init

public void init(Hashtable parameters)

Inits parameters.

Specified by:

init in interface FormComponent

Parameters:

parameters - the Hashtable with parameters

attribute	values	default	required	meaning
orientation	horizontal / vertical	vertical	no	The orientation for component.
attr			no	The attribute.
title			no	The title for container.
anim	yes/no	no	no	Sets the animation enabled/disabled
border	raised;lowered;bevellowered;bevelraised		no	Border for container
borderclass			no	Border class used to create the border for container. See createCustomBorder(String, Hashtable)
icon			no	Path to icon showed in container
time		200	no	Sets deploying/undeploying duration in milliseconds
startshowed	yes/no	no	no	Sets the deploying initial status
reverseicon	yes/no	no	no	Changes the order when the icons are shown
valign	center/bottom/top	top	no	The vertical alignment for component
tooltip			no	Specifies the tip for container.
expandlast	yes/no		no	Indicates whether the component placed in the bottom of this panel will be expanded and take up all remaining column space.
expand	yes/no		no	Indicates the expansion for component.
expandvertical	yes/no		no	Indicates the expansion for component vertically.
bgcolor			no	The background color. A possible color for ColorConstants or a RGB value like: '150;230;23'.
opaque	yes/no	yes	no	The opacity condition
margin		yes	no	Fixes insets for component. Its structure must be 4 values for insets separated by ';'(top;left;bottom;right).

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

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.

isDeploy

public boolean isDeploy()

setBorder

public void setBorder(Border border)

Overrides:

setBorder in class JComponent

setDeploy

public void setDeploy(boolean deploy)

computeIntersection

public static boolean computeIntersection(Rectangle dest,
                          int rx,
                          int ry,
                          int rw,
                          int rh)

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

createDeployBorder

protected void createDeployBorder(String title)

createCustomBorder

protected void createCustomBorder(String borderClassName,
                      Hashtable parameters)

Creates by reflection a specific border.

Parameters:

borderClassName - The border class to do Class.forName about it

parameters - Parameters specified in .xml definition that are necessary for border

setTitle

public void setTitle(String title)

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

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement

setLayout

public void setLayout(LayoutManager mgr)

Overrides:

setLayout in class Container

addImpl

protected void addImpl(Component comp,
           Object constraints,
           int index)

Overrides:

addImpl in class Container

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getMaximumSize

public Dimension getMaximumSize()

Overrides:

getMaximumSize in class JComponent

isVerticalOrientation

protected boolean isVerticalOrientation()

setPreferredSize

public void setPreferredSize(Dimension preferredSize)

Overrides:

setPreferredSize in class JComponent

getLayout

public LayoutManager getLayout()

Overrides:

getLayout in class Container

setOpaque

public void setOpaque(boolean isOpaque)

Overrides:

setOpaque in class JComponent

saveVisiblePreference

protected void saveVisiblePreference()

Saves the visible preferences.

getVisiblePreferenceKey

protected String getVisiblePreferenceKey()

Gets the preferred split position.

Returns:

the split position

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

initPreferences

public void initPreferences(ApplicationPreferences ap,
                   String user)

Specified by:

initPreferences in interface HasPreferenceComponent

isFirstShow

public boolean isFirstShow()

Returns:

true if the first time the component must be expanded and false if it must be shown collapsed

setFirstShow

public void setFirstShow(boolean doFirstShow)

Configure how the component must appear the first time (expanded or collapsed)

Parameters:

doFirstShow -

isFirstTime

public boolean isFirstTime()

Returns:

true if the panel has not be painted yet

getUser

protected String getUser()

Gets user calling to Application.getReferenceLocator() and ReferenceLocator.getUser().

Returns:

the user