com.ontimize.gui.container

Class SplitPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSplitPane

com.ontimize.gui.container.SplitPane

All Implemented Interfaces:

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

public class SplitPane
extends JSplitPane
implements FormComponent, IdentifiedElement, AccessForm, HasPreferenceComponent

This class implements a scrollable separator. For a good performance, only two components are allowed.
If orientation is vertical(horizontal), first component will be placed on top(on the left).

Author:

Imatia Innovation

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JSplitPane

JSplitPane.AccessibleJSplitPane

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	addedComponent Indicates whether a component has just added.
protected Object	attribute The attribute reference.
static int	defaultDividerSizeValue
protected boolean	initiatedPreferences
protected int	orientation The orientation.
protected Form	parentForm The parent form reference.
protected String	userPrefs The user reference.

Fields inherited from class javax.swing.JSplitPane

BOTTOM, CONTINUOUS_LAYOUT_PROPERTY, continuousLayout, DIVIDER, DIVIDER_LOCATION_PROPERTY, DIVIDER_SIZE_PROPERTY, dividerSize, HORIZONTAL_SPLIT, LAST_DIVIDER_LOCATION_PROPERTY, lastDividerLocation, LEFT, leftComponent, ONE_TOUCH_EXPANDABLE_PROPERTY, oneTouchExpandable, ORIENTATION_PROPERTY, RESIZE_WEIGHT_PROPERTY, RIGHT, rightComponent, TOP, VERTICAL_SPLIT

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

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Component c, Object cons) Adds the component in function of constraints.
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager parentLayout) Description method to return the constraints component to place correctly in parent container.
protected String	getPositionPreferenceKey() Gets the preferred split position.
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().
void	init(Hashtable parameters) Inits parameters.
void	initPermissions() Inits permissions.
void	initPreferences(ApplicationPreferences ap, String user) Inits preferences for user.
boolean	isRestricted() The restricted condition.
void	remove(Component component)
protected void	saveLocationPreference() Saves the location preferences.
void	setComponentLocale(Locale l)
void	setDividerLocation(double proportionalLocation)
void	setDividerLocation(int l)
void	setParentForm(Form form) Method declaration to set the form that contains the component.
void	setResourceBundle(ResourceBundle res) Sets the language resource bundle.
void	updateUI()

Methods inherited from class javax.swing.JSplitPane

addImpl, getAccessibleContext, getBottomComponent, getDividerLocation, getDividerSize, getLastDividerLocation, getLeftComponent, getMaximumDividerLocation, getMinimumDividerLocation, getOrientation, getResizeWeight, getRightComponent, getTopComponent, getUI, getUIClassID, isContinuousLayout, isOneTouchExpandable, isValidateRoot, paintChildren, paramString, remove, removeAll, resetToPreferredSizes, setBottomComponent, setContinuousLayout, setDividerSize, setLastDividerLocation, setLeftComponent, setOneTouchExpandable, setOrientation, setResizeWeight, setRightComponent, setTopComponent, setUI

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, paint, paintBorder, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, 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, 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, setEnabled, setVisible

Field Detail

defaultDividerSizeValue

public static int defaultDividerSizeValue

initiatedPreferences

protected boolean initiatedPreferences

orientation

protected int orientation

The orientation. By default, JSplitPane.VERTICAL_SPLIT

addedComponent

protected boolean addedComponent

Indicates whether a component has just added. By default, false.

attribute

protected Object attribute

The attribute reference. By default, null

parentForm

protected Form parentForm

The parent form reference. By default, null.

userPrefs

protected String userPrefs

The user reference. By default null.

Constructor Detail

SplitPane

public SplitPane(Hashtable parameters)

The class constructor. Calls to JSplitPane constructor, inits parameters and sets orientation.

Parameters:

parameters - the Hashtable with parameters

Method Detail

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

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	h or horizontal / vertical or v	vertical	no	The orientation for component.
attr			no	The attribute.
dividersize	Integer	10	no	The size of the split panel divider
bgcolor			no	The background color. A possible color for ColorConstants or a RGB value like: '150;230;23'
opaque	yes/no	yes	no	The opaque condition for split pane

add

public void add(Component c,
       Object cons)

Adds the component in function of constraints.

Overrides:

add in class Container

Parameters:

c - the component

cons - the constraints for component

remove

public void remove(Component component)

Overrides:

remove in class JSplitPane

setResourceBundle

public void setResourceBundle(ResourceBundle res)

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:

res - the new language bundle.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

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.

updateUI

public void updateUI()

Overrides:

updateUI in class JSplitPane

initPermissions

public void initPermissions()

Inits permissions. Empty.

Specified by:

initPermissions in interface SecureElement

setDividerLocation

public void setDividerLocation(int l)

Overrides:

setDividerLocation in class JSplitPane

setDividerLocation

public void setDividerLocation(double proportionalLocation)

Overrides:

setDividerLocation in class JSplitPane

saveLocationPreference

protected void saveLocationPreference()

Saves the location preferences.

getUser

protected String getUser()

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

Returns:

the user

isRestricted

public boolean isRestricted()

The restricted condition.

Specified by:

isRestricted in interface SecureElement

Returns:

boolean the condition of restricted value. By default, false.

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

getPositionPreferenceKey

protected String getPositionPreferenceKey()

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)

Inits preferences for user.

Specified by:

initPreferences in interface HasPreferenceComponent

Parameters:

ap - the application preferences

user - the user