IltDefaultAlarmCountGraphic (Rogue Wave JViews 9.2 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - ilog.tgo.graphic.IltDefaultAlarmCountGraphic

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

IltImpactAlarmCountGraphic
```
public class IltDefaultAlarmCountGraphic
extends JComponent
```
Graphical component representing an alarm count. It handles both traps and raw alarms. It displays an alarm count label, with optional inner and outer borders. Properties of interest:
- labelBackgroundColor: background color represents the most severe new alarm.
- outerBorderColor: represents the most severe outstanding alarm. Use null for transparency.
- outerBorderWidth: width of the outer border -- defaults to 2.
- innerBorderColor: color for the separator border between the outer border and the alarm count. Use null for transparency.
- innerBorderWidth: width of the inner border -- defaults to 1.
- innerBorderVisible: true to display the inner border -- defaults to false.
- label: represents the number of outstanding alarms for the highest severity; the highest severity; and an indicator of the presence of other less severe alarms.
- icon: represents the alarm severity.
- iconVisible: indicates if the icon shall be visible or not.
- iconPosition: defines the position of the icon relative to the highest severity text. Possible values are: IlvConstants.TRAILING or IlvConstants.LEADING.
Since:

JTGO 4.0

See Also:

IltImpactAlarmCountGraphic, Serialized Form

Nested Class Summary
- 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 int`	`baseline`
`protected int`	`count`
`protected String`	`countText`
`protected int`	`ellipsisWidth`
`protected boolean`	`hasLessSevereAlarms`
`protected Image`	`icon`
`protected Dimension`	`iconDimension`
`protected int`	`iconPosition`
`protected boolean`	`iconVisible`
`protected Color`	`innerBorderColor`
`protected boolean`	`innerBorderVisible`
`protected int`	`innerBorderWidth`
`protected String`	`label`
`protected Color`	`labelBackgroundColor`
`protected boolean`	`maxTextLayoutValid`
`protected Color`	`outerBorderColor`
`protected int`	`outerBorderWidth`
`protected String`	`severityText`
`protected boolean`	`textLayoutValid`
`protected TextLayout`	`tlCount`
`protected TextLayout`	`tlEllipsis`
`protected TextLayout`	`tlLabel`
`protected TextLayout`	`tlMaxCount`
`protected TextLayout`	`tlMaxLabel`
`protected TextLayout`	`tlMaxSeverity`
`protected TextLayout`	`tlMaxUnit`
`protected TextLayout`	`tlMore`
`protected TextLayout`	`tlSeverity`
`protected TextLayout`	`tlUnit`
`protected String`	`unitText`
`protected boolean`	`useLabel`

Fields inherited from class javax.swing.JComponent
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
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

IltDefaultAlarmCountGraphic()
Default constructor.

Constructors
Constructor and Description
`IltDefaultAlarmCountGraphic()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected float`	`drawText(Graphics2D g2d, TextLayout textLayout, String text, int x, int y, int remain, float fieldWidth, int alignment)`
`Image`	`getIcon()` Returns the alarm severity icon.
`int`	`getIconPosition()` Returns the position of the icon relative to the alarm count label.
`Color`	`getInnerBorderColor()` Returns the inner border color.
`int`	`getInnerBorderWidth()` Returns the inner border width.
`String`	`getLabel()` Returns the alarm count label.
`Color`	`getLabelBackgroundColor()` Returns the label background color.
`protected String`	`getLargestCountText()`
`protected String`	`getLargestSeverityText()`
`protected String`	`getLargestText()`
`protected String`	`getLargestUnitText()`
`Dimension`	`getMinimumSize()` If the minimum size has been set to a non-`null` value just returns it.
`Color`	`getOuterBorderColor()` Returns the outer border color.
`int`	`getOuterBorderWidth()` Returns the outer border width.
`Dimension`	`getPreferredSize()` Gets the preferred size of this component.
`boolean`	`isIconVisible()` Returns if the icon representing the alarm severity is visible or not.
`boolean`	`isInnerBorderVisible()` Returns the visibility status of the inner border.
`protected void`	`paintComponent(Graphics g)`
`protected void`	`paintParsedLabel(Graphics2D g2d, int x, int y, int width)`
`protected void`	`paintUnparsedLabel(Graphics2D g2d, int x, int y, int width)`
`protected void`	`parseLabel()`
`protected void`	`setCount(int count)`
`void`	`setFont(Font font)` Sets the alarm count font.
`void`	`setIcon(Image im)` Sets the alarm severity icon.
`void`	`setIconPosition(int v)` Sets the position of the icon relative to the alarm count label.
`void`	`setIconVisible(boolean v)` Sets if the icon representing the alarm severity should be visible or not.
`void`	`setInnerBorderColor(Color color)` Sets the inner border color.
`void`	`setInnerBorderVisible(boolean innerBorderVisible)` Sets the inner border visibility.
`void`	`setInnerBorderWidth(int width)` Sets the inner border width.
`void`	`setLabel(String label)` Sets the alarm count label.
`void`	`setLabelBackgroundColor(Color labelBackgroundColor)` Sets the label background color.
`void`	`setOuterBorderColor(Color color)` Sets the outer border color.
`void`	`setOuterBorderWidth(int width)` Sets the outer border width.
`protected void`	`updateMaxTextLayouts(FontRenderContext frc)`
`protected void`	`updateTextLayouts(FontRenderContext frc)`

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

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, getAccessibleContext, 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, 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

- Field Detail
  - labelBackgroundColor
```
protected Color labelBackgroundColor
```
    Internal: do not use!
  - outerBorderColor
```
protected Color outerBorderColor
```
    Internal: do not use!
  - outerBorderWidth
```
protected int outerBorderWidth
```
    Internal: do not use!
  - innerBorderColor
```
protected Color innerBorderColor
```
    Internal: do not use!
  - innerBorderWidth
```
protected int innerBorderWidth
```
    Internal: do not use!
  - innerBorderVisible
```
protected boolean innerBorderVisible
```
    Internal: do not use!
  - label
```
protected String label
```
    Internal: do not use!
  - useLabel
```
protected boolean useLabel
```
    Internal: do not use!
  - count
```
protected int count
```
    Internal: do not use!
  - countText
```
protected String countText
```
    Internal: do not use!
  - unitText
```
protected String unitText
```
    Internal: do not use!
  - severityText
```
protected String severityText
```
    Internal: do not use!
  - hasLessSevereAlarms
```
protected boolean hasLessSevereAlarms
```
    Internal: do not use!
  - icon
```
protected Image icon
```
    Internal: do not use!
  - iconVisible
```
protected boolean iconVisible
```
    Internal: do not use!
  - iconPosition
```
protected int iconPosition
```
    Internal: do not use!
  - iconDimension
```
protected Dimension iconDimension
```
    Internal: do not use!
  - maxTextLayoutValid
```
protected boolean maxTextLayoutValid
```
    Internal: do not use!
  - tlMaxCount
```
protected TextLayout tlMaxCount
```
    Internal: do not use!
  - tlMaxUnit
```
protected TextLayout tlMaxUnit
```
    Internal: do not use!
  - tlMaxSeverity
```
protected TextLayout tlMaxSeverity
```
    Internal: do not use!
  - tlMaxLabel
```
protected TextLayout tlMaxLabel
```
    Internal: do not use!
  - tlEllipsis
```
protected TextLayout tlEllipsis
```
    Internal: do not use!
  - ellipsisWidth
```
protected int ellipsisWidth
```
    Internal: do not use!
  - textLayoutValid
```
protected boolean textLayoutValid
```
    Internal: do not use!
  - tlCount
```
protected TextLayout tlCount
```
    Internal: do not use!
  - tlUnit
```
protected TextLayout tlUnit
```
    Internal: do not use!
  - tlSeverity
```
protected TextLayout tlSeverity
```
    Internal: do not use!
  - tlMore
```
protected TextLayout tlMore
```
    Internal: do not use!
  - tlLabel
```
protected TextLayout tlLabel
```
    Internal: do not use!
  - baseline
```
protected int baseline
```
    Internal: do not use!
- Constructor Detail
  - IltDefaultAlarmCountGraphic
```
public IltDefaultAlarmCountGraphic()
```
    Default constructor.
- Method Detail
  - setLabelBackgroundColor
```
public void setLabelBackgroundColor(Color labelBackgroundColor)
```
    Sets the label background color.
    
    Parameters:
    
    labelBackgroundColor - The color to be set for the label background.
  - getLabelBackgroundColor
```
public Color getLabelBackgroundColor()
```
    Returns the label background color.
    Default value: null.
    
    Returns:
    
    The color of the label background. null indicates transparency.
  - setOuterBorderColor
```
public void setOuterBorderColor(Color color)
```
    Sets the outer border color.
    
    Parameters:
    
    color - The color to be set for the outer border.
  - getOuterBorderColor
```
public Color getOuterBorderColor()
```
    Returns the outer border color.
    Default value: null.
    
    Returns:
    
    The color of the outer border. null indicates transparency.
  - setOuterBorderWidth
```
public void setOuterBorderWidth(int width)
```
    Sets the outer border width.
    
    Parameters:
    
    width - The width to be set for the outer border.
  - getOuterBorderWidth
```
public int getOuterBorderWidth()
```
    Returns the outer border width.
    Default value: 2.
    
    Returns:
    
    The width of the outer border.
  - setInnerBorderColor
```
public void setInnerBorderColor(Color color)
```
    Sets the inner border color.
    
    Parameters:
    
    color - The color to be set for the inner border.
  - getInnerBorderColor
```
public Color getInnerBorderColor()
```
    Returns the inner border color.
    Default value: null.
    
    Returns:
    
    The color of the inner border. null indicates transparency.
  - setInnerBorderWidth
```
public void setInnerBorderWidth(int width)
```
    Sets the inner border width.
    
    Parameters:
    
    width - The width to be set for the inner border.
  - getInnerBorderWidth
```
public int getInnerBorderWidth()
```
    Returns the inner border width.
    Default value: 1.
    
    Returns:
    
    The width of the inner border.
  - setInnerBorderVisible
```
public void setInnerBorderVisible(boolean innerBorderVisible)
```
    Sets the inner border visibility.
    
    Parameters:
    
    innerBorderVisible - true to show the inner border.
  - isInnerBorderVisible
```
public boolean isInnerBorderVisible()
```
    Returns the visibility status of the inner border.
    Default value: false.
    
    Returns:
    
    Returns true when the inner border is visible.
  - setLabel
```
public void setLabel(String label)
```
    Sets the alarm count label.
    
    Parameters:
    
    label - The label for the alarm count.
  - getLabel
```
public String getLabel()
```
    Returns the alarm count label.
    
    Returns:
    
    The label for the alarm count.
  - setIcon
```
public void setIcon(Image im)
```
    Sets the alarm severity icon.
    
    Parameters:
    
    im - The alarm severity icon
    
    Since:
    
    JTGO 4.5
  - getIcon
```
public Image getIcon()
```
    Returns the alarm severity icon.
    
    Returns:
    
    The alarm severity icon.
    
    Since:
    
    JTGO 4.5
  - setIconVisible
```
public void setIconVisible(boolean v)
```
    Sets if the icon representing the alarm severity should be visible or not.
    
    Parameters:
    
    v - Visibility flag
    
    Since:
    
    JTGO 4.5
  - isIconVisible
```
public boolean isIconVisible()
```
    Returns if the icon representing the alarm severity is visible or not.
    
    Returns:
    
    true if the icon is visible
    
    Since:
    
    JTGO 4.5
  - setIconPosition
```
public void setIconPosition(int v)
```
    Sets the position of the icon relative to the alarm count label.
    Possible values are:
    - IlvConstants.TRAILING
    - IlvConstants.LEADING
    Parameters:
    
    v - Icon position
    
    Since:
    
    JTGO 4.5
  - getIconPosition
```
public int getIconPosition()
```
    Returns the position of the icon relative to the alarm count label.
    Possible values are:
    - IlvConstants.TRAILING
    - IlvConstants.LEADING
    Default value is IlvConstants.TRAILING.
    Since:
    
    JTGO 4.5
  - parseLabel
```
protected void parseLabel()
```
    Internal: do not use!
  - setCount
```
protected void setCount(int count)
```
    Internal: do not use!
  - getLargestText
```
protected String getLargestText()
```
    Internal: do not use!
  - getLargestCountText
```
protected String getLargestCountText()
```
    Internal: do not use!
  - getLargestUnitText
```
protected String getLargestUnitText()
```
    Internal: do not use!
  - getLargestSeverityText
```
protected String getLargestSeverityText()
```
    Internal: do not use!
  - setFont
```
public void setFont(Font font)
```
    Sets the alarm count font.
    
    Overrides:
    
    setFont in class JComponent
  - getMinimumSize
```
public Dimension getMinimumSize()
```
    If the minimum size has been set to a non-null value just returns it. If the UI delegate's getMinimumSize method returns a non-null value then return that; otherwise defer to the component's layout manager.
    
    Overrides:
    
    getMinimumSize in class JComponent
    
    Returns:
    
    the value of the minimumSize property
    
    See Also:
    
    Component.getMinimumSize()
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Gets the preferred size of this component.
    
    Overrides:
    
    getPreferredSize in class JComponent
    
    Returns:
    
    a dimension object indicating this component's preferred size
    
    See Also:
    
    Component.getPreferredSize()
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    Overrides:
    
    paintComponent in class JComponent
    
    See Also:
    
    Component.paint(java.awt.Graphics)
    
    Internal: do not use!
  - paintParsedLabel
```
protected void paintParsedLabel(Graphics2D g2d,
                                int x,
                                int y,
                                int width)
```
    Internal: do not use!
  - drawText
```
protected float drawText(Graphics2D g2d,
                         TextLayout textLayout,
                         String text,
                         int x,
                         int y,
                         int remain,
                         float fieldWidth,
                         int alignment)
```
    Internal: do not use!
  - paintUnparsedLabel
```
protected void paintUnparsedLabel(Graphics2D g2d,
                                  int x,
                                  int y,
                                  int width)
```
    Internal: do not use!
  - updateTextLayouts
```
protected void updateTextLayouts(FontRenderContext frc)
```
    Internal: do not use!
  - updateMaxTextLayouts
```
protected void updateMaxTextLayouts(FontRenderContext frc)
```
    Internal: do not use!

Class IltDefaultAlarmCountGraphic

Nested Class Summary

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

labelBackgroundColor

outerBorderColor

outerBorderWidth

innerBorderColor

innerBorderWidth

innerBorderVisible

label

useLabel

count

countText

unitText

severityText

hasLessSevereAlarms

icon

iconVisible

iconPosition

iconDimension

maxTextLayoutValid

tlMaxCount

tlMaxUnit

tlMaxSeverity

tlMaxLabel

tlEllipsis

ellipsisWidth

textLayoutValid

tlCount

tlUnit

tlSeverity

tlMore

tlLabel

baseline

Constructor Detail

IltDefaultAlarmCountGraphic

Method Detail

setLabelBackgroundColor

getLabelBackgroundColor

setOuterBorderColor

getOuterBorderColor

setOuterBorderWidth

getOuterBorderWidth

setInnerBorderColor

getInnerBorderColor

setInnerBorderWidth

getInnerBorderWidth

setInnerBorderVisible

isInnerBorderVisible

setLabel

getLabel

setIcon

getIcon

setIconVisible

isIconVisible

setIconPosition

getIconPosition

parseLabel

setCount

getLargestText

getLargestCountText

getLargestUnitText

getLargestSeverityText

setFont

getMinimumSize

getPreferredSize

paintComponent