Ontimize 5.2072EN

com.ontimize.gui.container
Class Column

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycom.ontimize.gui.container.Column
All Implemented Interfaces:
AccessForm, javax.accessibility.Accessible, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.MenuContainer, SecureElement, java.io.Serializable
Direct Known Subclasses:
CardPanel, ColumnRadioButtonGroup, MultiReference

public class Column
extends javax.swing.JPanel
implements FormComponent, IdentifiedElement, AccessForm

An extended JPanel with new functionalities to put the information in vertical layout grouped in a column.

Author:
Imatia Innovation
See Also:
Serialized Form

Nested Class Summary
 
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
static java.lang.String ABOVE_BOTTOM
          The key for title position
static java.lang.String ABOVE_TOP
          The key for title position
protected  FormPermission activedPermission
          To set the active permissions.
protected  int alignment
          The alignment.
protected  int alignmentV
          The vertical alignment.
protected  java.lang.Object attribute
          The attribute object.
static int B_BEVEL_LOWERED
          The bevel lowered value.
static int B_BEVEL_RAISED
          The bevel raised value.
static int B_COLOR
          The empty value.
static int B_LOWERED
          The bevel lowered value.
static int B_RAISED
          The bevel raised value.
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 BELOW_BOTTOM
          The key for title position
static java.lang.String BELOW_TOP
          The key for title position
static java.lang.String BEVEL_LOWERED
          Bevel lowered property.
static java.lang.String BEVEL_RAISED
          Bevel raised property.
protected  int borderPosition
          The border position.
static java.lang.String BOTTOM
          The key for title position
static java.lang.String COLOR
          Color property.
static java.lang.String COLUMN
          The name of class.
static java.lang.String EXPANDLAST
           
protected  boolean horizontalExpand
          To specify horizontal expand.
protected  java.lang.Double horizontalWeight
           
protected  boolean lastExpand
          Indicates whether the component placed in the bottom of column will be expanded and take up all remaining column space .
static java.lang.String LOWERED
          Lowered property.
protected  Form parentForm
          A reference to parent form.
protected  int preferredHigh
          The preferred column high.
protected  int preferredWidht
          The preferred column width.
protected  java.awt.Rectangle r
          A new Rectangle.
static java.lang.String RAISED
          Raised property
protected  boolean restricted
          The restricted condition.
protected  java.awt.TexturePaint texturePaint
           
protected  java.lang.String title
          The column title.
protected  javax.swing.border.TitledBorder titledBorder
          Indicates a special title with arbitrary border with the addition of a String title in a specified position and justification.
protected  boolean titleToUpperCase
           
static java.lang.String TOP
          The key for title position
static java.lang.String VALIGN
           
protected  FormPermission visiblePermission
          To set the visible permissions.
 
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
Column(java.util.Hashtable parameters)
          The class constructor.
 
Method Summary
protected  boolean checkEnabledPermission()
          Checks the enable permissions.
protected  boolean checkVisiblePermission()
          Checks the visibility permissions.
 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.awt.Dimension getMaximumSize()
           
 java.awt.Dimension getMinimumSize()
           
 java.lang.String getName()
           
 java.awt.Dimension getPreferredSize()
           
 java.util.Vector getTextsToTranslate()
          Returns all the texts in the element suitable for being translated.
 void init(java.util.Hashtable parameters)
          Inits parameters.
 void initPermissions()
          Inits permissions.
 boolean isFocusable()
           
 boolean isRestricted()
          Checks the restricted condition
protected  void paintComponent(java.awt.Graphics g)
           
 void setBackgroundImage(java.awt.Image im)
          Sets a background image in column.
 void setBackgroundPaint(java.awt.Paint p)
          Sets the backgroundpaint parameter and repaints the column.
 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 setResourceBundle(java.util.ResourceBundle resources)
          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 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, 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, 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
add, add, add, add, add, 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, 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, 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, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, 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

COLUMN

public static final java.lang.String COLUMN
The name of class. Used by L&F to put UI properties.

Since:
5.2062EN
See Also:
Constant Field Values

VALIGN

public static final java.lang.String VALIGN
See Also:
Constant Field Values

EXPANDLAST

public static final java.lang.String EXPANDLAST
See Also:
Constant Field Values

texturePaint

protected java.awt.TexturePaint texturePaint

title

protected java.lang.String title
The column title. By default is "null".


titledBorder

protected javax.swing.border.TitledBorder titledBorder
Indicates a special title with arbitrary border with the addition of a String title in a specified position and justification.


titleToUpperCase

protected boolean titleToUpperCase

horizontalExpand

protected boolean horizontalExpand
To specify horizontal expand. By default, "true".


horizontalWeight

protected java.lang.Double horizontalWeight

lastExpand

protected boolean lastExpand
Indicates whether the component placed in the bottom of column will be expanded and take up all remaining column space .


attribute

protected java.lang.Object attribute
The attribute object.


alignment

protected int alignment
The alignment. By default, TOP value.


alignmentV

protected int alignmentV
The vertical alignment. By default, TOP value.


parentForm

protected Form parentForm
A reference to parent form.


visiblePermission

protected FormPermission visiblePermission
To set the visible permissions.


activedPermission

protected FormPermission activedPermission
To set the active permissions.


LOWERED

public static final java.lang.String LOWERED
Lowered property.

See Also:
Constant Field Values

RAISED

public static final java.lang.String RAISED
Raised property

See Also:
Constant Field Values

BEVEL_LOWERED

public static final java.lang.String BEVEL_LOWERED
Bevel lowered property.

See Also:
Constant Field Values

BEVEL_RAISED

public static final java.lang.String BEVEL_RAISED
Bevel raised property.

See Also:
Constant Field Values

COLOR

public static final java.lang.String COLOR
Color property.

See Also:
Constant Field Values

B_LOWERED

public static final int B_LOWERED
The bevel lowered value.

See Also:
Constant Field Values

B_RAISED

public static final int B_RAISED
The bevel raised value.

See Also:
Constant Field Values

B_BEVEL_LOWERED

public static final int B_BEVEL_LOWERED
The bevel lowered value.

See Also:
Constant Field Values

B_BEVEL_RAISED

public static final int B_BEVEL_RAISED
The bevel raised value.

See Also:
Constant Field Values

B_COLOR

public static final int B_COLOR
The empty value.

See Also:
Constant Field Values

borderPosition

protected int borderPosition
The border position.


ABOVE_TOP

public static final java.lang.String ABOVE_TOP
The key for title position

See Also:
Constant Field Values

TOP

public static final java.lang.String TOP
The key for title position

See Also:
Constant Field Values

BELOW_TOP

public static final java.lang.String BELOW_TOP
The key for title position

See Also:
Constant Field Values

ABOVE_BOTTOM

public static final java.lang.String ABOVE_BOTTOM
The key for title position

See Also:
Constant Field Values

BOTTOM

public static final java.lang.String BOTTOM
The key for title position

See Also:
Constant Field Values

BELOW_BOTTOM

public static final java.lang.String BELOW_BOTTOM
The key for title position

See Also:
Constant Field Values

preferredWidht

protected int preferredWidht
The preferred column width. By default, -1.


preferredHigh

protected int preferredHigh
The preferred column high. By default, -1.


backgroundPaint

protected java.awt.Paint backgroundPaint
A reference to background paint. By default, null.


r

protected java.awt.Rectangle r
A new Rectangle.


backgroundImage

protected java.awt.Image backgroundImage
A reference to specify a background image in the column.


restricted

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

Constructor Detail

Column

public Column(java.util.Hashtable parameters)
The class constructor. Calls to super() and initializes 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

getName

public java.lang.String getName()

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

init

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

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

attribute values default required meaning
attr yes The attribute.
expandlast yes/no no Indicates whether the component placed in the bottom of column will be expanded and take up all remaining column space.
title no The column title.
border lowered/raised/bevellowered/bevelraised raised no The border definition.
titleposition abovetop/top/belowtop/abovebottom/bottom/belowbottom no The title-position of the titled border..
expand yes/no or numerical value like weight in GridBagConstraints no no Indicates the horizontal expansion.
valign top/center/bottom no Indicates the vertical alignment.
height no The preferred column height in pixels. Useful for specifying empty columns.
width no The preferred column width in pixels. Useful for specifying empty columns.
bgimage no The path to background image.
bgcolor no The background color. A possible color for ColorConstants or a RGB value like: '150;230;23'
bgpaint no Paint value to use in this container. See ColorConstants.paintNameToPaint(String)
opaque yes/no yes yes Indicates whether column is opaque.
margin no Indicates the column margin.
textureimage no Path to source icon to extract a image and create a TexturePaint
touppercase no To put text of title border into upper case.
titlebgcolor no The color of the border ColorTitleBorder. A possible color for ColorConstants or a RGB value like: '150;230;23'

getPreferredSize

public java.awt.Dimension getPreferredSize()

getMinimumSize

public java.awt.Dimension getMinimumSize()

getMaximumSize

public java.awt.Dimension getMaximumSize()

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

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 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()
Inits permissions.

Specified by:
initPermissions in interface SecureElement
See Also:
checkEnabledPermission(), setEnabled(boolean), checkVisiblePermission(), checkEnabledPermission()

checkVisiblePermission

protected boolean checkVisiblePermission()
Checks the visibility permissions.

Returns:
The visibility condition

checkEnabledPermission

protected boolean checkEnabledPermission()
Checks the enable permissions.

Returns:
The enable condition

isRestricted

public boolean isRestricted()
Checks the restricted condition

Specified by:
isRestricted in interface SecureElement
Returns:
the restricted condition

setBackgroundPaint

public void setBackgroundPaint(java.awt.Paint p)
Sets the backgroundpaint parameter and repaints the column.

Parameters:
p - The background paint configuration

paintComponent

protected void paintComponent(java.awt.Graphics g)

setBackgroundImage

public void setBackgroundImage(java.awt.Image im)
Sets a background image in column.

Parameters:
im - The awt image to set in background image
See Also:
Image

isFocusable

public boolean isFocusable()

Ontimize