Ontimize 5.2071EN

com.ontimize.gui.alarm
Class AlarmList

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bycom.ontimize.gui.alarm.AlarmList
All Implemented Interfaces:
javax.accessibility.Accessible, DataComponent, java.util.EventListener, FormComponent, IdentifiedElement, java.awt.image.ImageObserver, Internationalization, java.awt.event.KeyListener, javax.swing.event.ListDataListener, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, java.awt.event.MouseListener, OpenDialog, SecureElement, java.io.Serializable

public class AlarmList
extends javax.swing.JPanel
implements DataComponent, javax.swing.event.ListSelectionListener, javax.swing.event.ListDataListener, java.awt.event.MouseListener, OpenDialog, java.awt.event.KeyListener

Component that implements one alarm list. These alarms can be classified in two different types:
- information: a normal informative text.
-warnings: informative text with audible and visual signals until these alarms are 'recognized'. The alarm will be 'recognized' when the button, which is associated with this alarm, is stroked.(It appears near the text).
Alarms are shown in a list component.

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
protected  java.lang.Object attribute
           
static java.lang.String BUTTON_KEY
           
protected  boolean modificable
           
protected  java.awt.Frame parentFrame
           
protected  boolean required
           
protected  boolean show
           
protected  java.lang.Object storedValue
           
 
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.DataComponent
COMP_FOCUS_YELLOW, GREEN_VERY_LIGHT, LIGHT_GRAY_BLUE, LIGHT_GREYISH_BLUE, VERY_LIGHT_BLUE, VERY_LIGHT_GRAY, VERY_LIGHT_PINK, VERY_LIGHT_RED, VERY_LIGHT_SKYBLUE, VERY_LIGHT_YELLOW, VERY_LIGHT_YELLOW_2
 
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
AlarmList(java.util.Hashtable parameters)
           
 
Method Summary
 void addAlarm(java.lang.Object key, java.lang.String code, int type, boolean recognized)
           
 void addAlarm(java.lang.Object key, java.lang.String text, int type, java.lang.String code, boolean recognized)
           
 void addAlarm(java.lang.Object key, java.lang.String text, int type, java.lang.String code, java.util.Date date, boolean recognized)
           
 void addAlarmListener(AlarmListener l)
           
 void contentsChanged(javax.swing.event.ListDataEvent e)
           
 void deleteData()
          The method to delete data for component.
 boolean existNoRecognize()
           
 void fireAlarmAcknowledge(Alarm a)
           
 void fireAlarmFired(Alarm a)
           
 void fireContentsChanged()
           
 java.util.Vector getAlarmList()
           
 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.
 javax.swing.JList getJList()
           
 java.lang.String getLabelComponentText()
          Returns the label text component.
 java.awt.Dimension getMaximumSize()
           
 javax.swing.ListCellRenderer getRenderer()
           
 int getSQLDataType()
          Returns the sql data type according to java.sql.Types
 java.util.Vector getTextsToTranslate()
          Returns all the texts in the element suitable for being translated.
 java.lang.Object getValue()
          Gets the value of a component.
 void init(java.util.Hashtable parameters)
          Main method to init an object from parameters hashtable.
 void initPermissions()
           
 void intervalAdded(javax.swing.event.ListDataEvent e)
           
 void intervalRemoved(javax.swing.event.ListDataEvent e)
           
 boolean isEmpty()
          Checks the data existence in component.
 boolean isHidden()
          Indicates to check the visibility condition for a component.
 boolean isModifiable()
          Checks the modifiable condition for a component.
 boolean isModified()
          This method should be return true when data have been modified.
 boolean isRequired()
          Indicates the required condition for a component.
 boolean isRestricted()
           
 void keyPressed(java.awt.event.KeyEvent e)
           
 void keyReleased(java.awt.event.KeyEvent e)
           
 void keyTyped(java.awt.event.KeyEvent e)
           
 void mouseClicked(java.awt.event.MouseEvent e)
           
 void mouseEntered(java.awt.event.MouseEvent e)
           
 void mouseExited(java.awt.event.MouseEvent e)
           
 void mousePressed(java.awt.event.MouseEvent e)
           
 void mouseReleased(java.awt.event.MouseEvent e)
           
 void removeAlarm(int index)
           
 void removeSelected()
           
 void setComponentLocale(java.util.Locale l)
           
 void setModifiable(boolean modif)
          Establishes the modifiable condition for a component.
 void setParentFrame(java.awt.Frame parent)
          This method is called from Form for each component that implements this interface.
 void setRequired(boolean required)
          Sets required a component according to condition.
 void setResourceBundle(java.util.ResourceBundle r)
          Sets the language resource bundle.
 void setValue(java.lang.Object value)
          Sets the value for component.
 void valueChanged(javax.swing.event.ListSelectionEvent e)
           
 
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, getMinimumSize, getNextFocusableComponent, getPreferredSize, 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, paintComponent, 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, setEnabled, setFont, setForeground, 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, 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, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, 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, setEnabled, setVisible
 

Field Detail

BUTTON_KEY

public static java.lang.String BUTTON_KEY

attribute

protected java.lang.Object attribute

storedValue

protected java.lang.Object storedValue

parentFrame

protected java.awt.Frame parentFrame

show

protected boolean show

required

protected boolean required

modificable

protected boolean modificable
Constructor Detail

AlarmList

public AlarmList(java.util.Hashtable parameters)
Method Detail

getAlarmList

public java.util.Vector getAlarmList()

getRenderer

public javax.swing.ListCellRenderer getRenderer()

addAlarm

public void addAlarm(java.lang.Object key,
                     java.lang.String code,
                     int type,
                     boolean recognized)

addAlarm

public void addAlarm(java.lang.Object key,
                     java.lang.String text,
                     int type,
                     java.lang.String code,
                     boolean recognized)

addAlarm

public void addAlarm(java.lang.Object key,
                     java.lang.String text,
                     int type,
                     java.lang.String code,
                     java.util.Date date,
                     boolean recognized)

removeAlarm

public void removeAlarm(int index)

removeSelected

public void removeSelected()

init

public void init(java.util.Hashtable parameters)
Description copied from interface: FormComponent
Main method to init an object from parameters hashtable.

Specified by:
init in interface FormComponent
Parameters:
parameters - the hashtable with pairs (Key,Value). For example:

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

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

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

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 r)
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:
r - the new language bundle.

setComponentLocale

public void setComponentLocale(java.util.Locale l)
Specified by:
setComponentLocale in interface Internationalization

setParentFrame

public void setParentFrame(java.awt.Frame parent)
Description copied from interface: OpenDialog
This method is called from Form for each component that implements this interface. It fixes the parent frame for element. This frame is needed to open the modal dialog.

Specified by:
setParentFrame in interface OpenDialog
Parameters:
parent - the frame

getJList

public javax.swing.JList getJList()

contentsChanged

public void contentsChanged(javax.swing.event.ListDataEvent e)
Specified by:
contentsChanged in interface javax.swing.event.ListDataListener

fireContentsChanged

public void fireContentsChanged()

intervalRemoved

public void intervalRemoved(javax.swing.event.ListDataEvent e)
Specified by:
intervalRemoved in interface javax.swing.event.ListDataListener

intervalAdded

public void intervalAdded(javax.swing.event.ListDataEvent e)
Specified by:
intervalAdded in interface javax.swing.event.ListDataListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)
Specified by:
mouseClicked in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)
Specified by:
mouseExited in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)
Specified by:
mouseEntered in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)
Specified by:
mouseReleased in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)
Specified by:
mousePressed in interface java.awt.event.MouseListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)
Specified by:
keyReleased in interface java.awt.event.KeyListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Specified by:
keyPressed in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)
Specified by:
keyTyped in interface java.awt.event.KeyListener

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent e)
Specified by:
valueChanged in interface javax.swing.event.ListSelectionListener

addAlarmListener

public void addAlarmListener(AlarmListener l)

fireAlarmFired

public void fireAlarmFired(Alarm a)

fireAlarmAcknowledge

public void fireAlarmAcknowledge(Alarm a)

getMaximumSize

public java.awt.Dimension getMaximumSize()

isModified

public boolean isModified()
Description copied from interface: DataComponent
This method should be return true when data have been modified. The method setValue() should be change this condition.

Specified by:
isModified in interface DataComponent
Returns:
the modified condition

isRequired

public boolean isRequired()
Description copied from interface: DataComponent
Indicates the required condition for a component.

Specified by:
isRequired in interface DataComponent
Returns:
the required condition

setRequired

public void setRequired(boolean required)
Description copied from interface: DataComponent
Sets required a component according to condition.

Specified by:
setRequired in interface DataComponent
Parameters:
required - the required condition

isEmpty

public boolean isEmpty()
Description copied from interface: DataComponent
Checks the data existence in component.

Specified by:
isEmpty in interface DataComponent
Returns:
true when component is empty

isModifiable

public boolean isModifiable()
Description copied from interface: DataComponent
Checks the modifiable condition for a component. It is useful when it is not desired form deletes a component value.

Specified by:
isModifiable in interface DataComponent
Returns:
true when component is modifiable

setModifiable

public void setModifiable(boolean modif)
Description copied from interface: DataComponent
Establishes the modifiable condition for a component. When component is not modifiable, data will not be deleted automatically in DeleteFields call.

Specified by:
setModifiable in interface DataComponent
Parameters:
modif - the boolean condition

isHidden

public boolean isHidden()
Description copied from interface: DataComponent
Indicates to check the visibility condition for a component.

Specified by:
isHidden in interface DataComponent
Returns:
the visibility condition

getSQLDataType

public int getSQLDataType()
Description copied from interface: DataComponent
Returns the sql data type according to java.sql.Types

Specified by:
getSQLDataType in interface DataComponent
Returns:
the Integer type

deleteData

public void deleteData()
Description copied from interface: DataComponent
The method to delete data for component.

Specified by:
deleteData in interface DataComponent

setValue

public void setValue(java.lang.Object value)
Description copied from interface: DataComponent
Sets the value for component.

Specified by:
setValue in interface DataComponent
Parameters:
value - the object with value to set

getLabelComponentText

public java.lang.String getLabelComponentText()
Description copied from interface: DataComponent
Returns the label text component. This label will change according to the Locale.

Specified by:
getLabelComponentText in interface DataComponent
Returns:
the label text

getValue

public java.lang.Object getValue()
Description copied from interface: DataComponent
Gets the value of a component.

Specified by:
getValue in interface DataComponent
Returns:
the object with value.

existNoRecognize

public boolean existNoRecognize()

initPermissions

public void initPermissions()
Specified by:
initPermissions in interface SecureElement

isRestricted

public boolean isRestricted()
Specified by:
isRestricted in interface SecureElement

Ontimize