com.ontimize.gui.field

Class ToggleImage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.ontimize.gui.field.ToggleImage

All Implemented Interfaces:

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

Direct Known Subclasses:

CheckToggleImage

public class ToggleImage
extends JPanel
implements FormComponent, AccessForm, IdentifiedElement

This class implements a component with two states. For each state an image is associated. Size for both images must be the same. Moreover, component allows resizing (setSize(), setBounds(), resize()) and internal status ('0'->OFF or '1'->ON) could be obtained from getStatus().

Author:

Imatia Innovation S.L.

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
static int	ALARM
protected ImageField	alarmImage
protected com.ontimize.gui.field.ToggleImage.AlarmImageObserver	alarmImageObserver
protected URL	alarmImageURL
static String	ALIGN
protected int	alignment
protected String	attribute
protected JLabel	attributeLabel
protected static int	BOTTOM
static String	CENTER_STR
protected int	dim
static String	DIM
protected ImageField	disabledImage
protected com.ontimize.gui.field.ToggleImage.DisabledImageObserver	disabledImageObserver
protected URL	disabledImageURL
protected FormPermission	enabledPermission
protected int	high
protected boolean	isAlarmImage
protected JPanel	labelPanel
protected int	labelPosition
protected String	labelText
static String	LABELVISIBLE
protected static int	LEFT
static String	LEFT_STR
protected int	loadStatusAlarm
protected int	loadStatusDisabled
protected int	loadStatusOff
protected int	loadStatusOn
static int	NO
static String	NO_STR
static int	OFF
protected ImageField	offImage
protected com.ontimize.gui.field.ToggleImage.OffImageObserver	offImageObserver
protected URL	offImageURL
static int	ON
protected ImageField	onImage
protected com.ontimize.gui.field.ToggleImage.OnImageObserver	onImageObserver
protected URL	onImageURL
protected JImage	panelImage
protected Form	parentForm
protected int	preferredStatus
protected boolean	restricted
protected static int	RIGHT
static String	RIGHT_STR
protected boolean	show
protected boolean	showLabel
protected int	status
static int	TEXT
static String	TEXT_STR
protected static int	TOP
static String	VALIGN
protected int	valignment
static String	VISIBLE
protected FormPermission	visiblePermission
protected int	width
static int	YES
static String	YES_STR

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

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkEnabledPermission()
protected boolean	checkVisiblePermission()
protected void	finalize()
Object	getAttribute() Gets the object attribute.
Object	getConstraints(LayoutManager layout) Description method to return the constraints component to place correctly in parent container.
Point	getImageOffset()
Insets	getInsets()
int	getStatus()
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
void	init(Hashtable parameters) Initializes parameters.
void	initPermissions()
boolean	isHidden()
boolean	isLabelVisible()
boolean	isRestricted()
void	setCallFormAlarm(boolean callAlarmForma)
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 parentForm) Method declaration to set the form that contains the component.
void	setResourceBundle(ResourceBundle resources) Sets the language resource bundle.
void	setStatus(int status) This method sets the component status and update the image
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, 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, 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, revalidate, 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, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ontimize.gui.field.FormComponent

isEnabled

Field Detail

ON

public static final int ON

See Also:

Constant Field Values

OFF

public static final int OFF

See Also:

Constant Field Values

ALARM

public static final int ALARM

See Also:

Constant Field Values

TOP

protected static final int TOP

See Also:

Constant Field Values

LEFT

protected static final int LEFT

See Also:

Constant Field Values

BOTTOM

protected static final int BOTTOM

See Also:

Constant Field Values

RIGHT

protected static final int RIGHT

See Also:

Constant Field Values

RIGHT_STR

public static final String RIGHT_STR

See Also:

Constant Field Values

LEFT_STR

public static final String LEFT_STR

See Also:

Constant Field Values

CENTER_STR

public static final String CENTER_STR

See Also:

Constant Field Values

LABELVISIBLE

public static final String LABELVISIBLE

See Also:

Constant Field Values

VISIBLE

public static final String VISIBLE

See Also:

Constant Field Values

NO

public static final int NO

See Also:

Constant Field Values

YES

public static final int YES

See Also:

Constant Field Values

TEXT

public static final int TEXT

See Also:

Constant Field Values

DIM

public static final String DIM

See Also:

Constant Field Values

YES_STR

public static final String YES_STR

See Also:

Constant Field Values

TEXT_STR

public static final String TEXT_STR

See Also:

Constant Field Values

NO_STR

public static final String NO_STR

See Also:

Constant Field Values

ALIGN

public static final String ALIGN

See Also:

Constant Field Values

VALIGN

public static final String VALIGN

See Also:

Constant Field Values

alignment

protected int alignment

valignment

protected int valignment

labelPosition

protected int labelPosition

status

protected int status

preferredStatus

protected int preferredStatus

loadStatusOn

protected int loadStatusOn

loadStatusOff

protected int loadStatusOff

loadStatusAlarm

protected int loadStatusAlarm

loadStatusDisabled

protected int loadStatusDisabled

onImage

protected ImageField onImage

offImage

protected ImageField offImage

alarmImage

protected ImageField alarmImage

disabledImage

protected ImageField disabledImage

onImageURL

protected URL onImageURL

offImageURL

protected URL offImageURL

alarmImageURL

protected URL alarmImageURL

disabledImageURL

protected URL disabledImageURL

attribute

protected String attribute

labelText

protected String labelText

width

protected int width

high

protected int high

dim

protected int dim

attributeLabel

protected JLabel attributeLabel

labelPanel

protected JPanel labelPanel

panelImage

protected JImage panelImage

isAlarmImage

protected boolean isAlarmImage

parentForm

protected Form parentForm

visiblePermission

protected FormPermission visiblePermission

enabledPermission

protected FormPermission enabledPermission

showLabel

protected boolean showLabel

show

protected boolean show

onImageObserver

protected com.ontimize.gui.field.ToggleImage.OnImageObserver onImageObserver

offImageObserver

protected com.ontimize.gui.field.ToggleImage.OffImageObserver offImageObserver

alarmImageObserver

protected com.ontimize.gui.field.ToggleImage.AlarmImageObserver alarmImageObserver

disabledImageObserver

protected com.ontimize.gui.field.ToggleImage.DisabledImageObserver disabledImageObserver

restricted

protected boolean restricted

Constructor Detail

ToggleImage

public ToggleImage(Hashtable parameters)

Method Detail

init

public void init(Hashtable parameters)

Initializes parameters.

attribute	values	default	required	meaning
attr			yes	The field attribute.
alarm	on/off		no	When enabled image blinks between state image and alarm image.
align	center/left/right	center	no	The alignment for field.
valign	center/top/bottom	top	no	The vertical alignment for field.
dim	no/text/yes	no	no	The resize possibilities (no resize, resize the insertion space, resize the space between label and text ).
imgOn			no	The image for on state.
imgOff			no	The image for off state
imgAlarm			no	The image for alarm state.
imgDisabled			no	The image for disabled state.
rotate	yes/no	no	no	Rotation of field. When this feature is enabled, height and width for image are interchanged.
status	on/off		no	Initial state for component.
width			no	Width of field.
height			no	Height of field.
label	left/right/top/bottom		bottom	Position of label respect of text.
labelvisible	yes/no		yes	The label visibility.
text	yes/no		yes	Alternative for attr text.

Specified by:

init in interface FormComponent

Parameters:

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

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

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.

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.

getConstraints

public Object getConstraints(LayoutManager layout)

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:

layout - the parent container reference

Returns:

the constraints for the component

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

getInsets

public Insets getInsets()

Overrides:

getInsets in class JComponent

setStatus

public void setStatus(int status)

This method sets the component status and update the image

Parameters:

status -

getStatus

public int getStatus()

setParentForm

public void setParentForm(Form parentForm)

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:

parentForm - the form reference

setCallFormAlarm

public void setCallFormAlarm(boolean callAlarmForma)

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

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

getImageOffset

public Point getImageOffset()

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

initPermissions

public void initPermissions()

Specified by:

initPermissions in interface SecureElement

checkVisiblePermission

protected boolean checkVisiblePermission()

checkEnabledPermission

protected boolean checkEnabledPermission()

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface SecureElement

isLabelVisible

public boolean isLabelVisible()

isHidden

public boolean isHidden()