ilog.views.chart

Class IlvLegendItem

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

ilog.views.chart.IlvLegendItem

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

IlvIconLegendItem, IlvRendererLegendItem

public class IlvLegendItem
extends JComponent

This class defines the object added to an IlvLegend. It consists of a graphical symbol and a label describing the data points that are displayed with the same style as this symbol.

Since:

JViews 5.0

See Also:

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 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
IlvLegendItem(String label) Creates a new IlvLegendItem with the specified label.

Method Summary

Modifier and Type	Method and Description
protected void	baseTextDirectionChanged() This method is invoked when the effective base text direction has changed.
protected void	componentOrientationChanged(ComponentOrientation oldOrientation, ComponentOrientation newOrientation) This method is invoked when the component orientation of this legend item has changed.
protected void	drawIntoHitmap(IlvChartHitmapDefinition definition, IlvChartHitmapAccumulator accumulator) Draws this item as an object into the hitmap.
void	drawLabel(Graphics g, Point2D center) Draws the label part of the item.
void	drawSymbol(Graphics g, Rectangle symbolBounds) Draws the symbol part of the item.
String	getLabel() Returns the label.
Dimension	getLabelDimension() Returns the dimension of the label part of the item.
IlvLegend	getLegend() Returns the legend associated with this item.
IlvIMapArea	getMapArea(IlvIMapDefinition mapdef, IlvIMapAttributes attrs) Returns the image map area definition of this item as an IlvIMapArea instance.
Dimension	getMaximumSize() Returns the maximum size.
Dimension	getMinimumSize() Returns the minimum size.
Dimension	getPreferredSize() Returns the preferred size.
int	getResolvedBaseTextDirection() Returns the resolved base text direction.
Border	getTextBorder() Returns the text border.
boolean	isOpaqueText() Returns whether the text is opaque.
protected void	paintComponent(Graphics g) Draws the item.
void	setComponentOrientation(ComponentOrientation o) Sets the component orientation of this legend item.
void	setFont(Font font) Sets the font of this item.
void	setForeground(Color color) Sets the text color of this item.
void	setLabel(String label) Sets a new label.
void	setOpaqueText(boolean opaque) Sets whether the text is opaque.
void	setTextBorder(Border border) Sets the text border.

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

Constructor Detail

IlvLegendItem

public IlvLegendItem(String label)

Creates a new IlvLegendItem with the specified label.

Method Detail

getLegend

public final IlvLegend getLegend()

Returns the legend associated with this item.

setComponentOrientation

public void setComponentOrientation(ComponentOrientation o)

Sets the component orientation of this legend item.

Overrides:

setComponentOrientation in class Component

Since:

JViews 8.8

componentOrientationChanged

protected void componentOrientationChanged(ComponentOrientation oldOrientation,
                                           ComponentOrientation newOrientation)

This method is invoked when the component orientation of this legend item has changed.

Parameters:

oldOrientation - The component orientation before the change.

newOrientation - The component orientation after the change.

Since:

JViews 8.8

See Also:

Component.getComponentOrientation(), setComponentOrientation(ComponentOrientation)

getResolvedBaseTextDirection

public int getResolvedBaseTextDirection()

Returns the resolved base text direction.

The base text direction influences the display of text strings that are composed of segments that are read from left to right as well as of segments that are read from right to left. It determines the order of these segments.

Returns:

One of IlvBidiUtil.CONTEXTUAL_DIRECTION, IlvBidiUtil.LEFT_TO_RIGHT, IlvBidiUtil.RIGHT_TO_LEFT.

Since:

JViews 8.8

baseTextDirectionChanged

protected void baseTextDirectionChanged()

This method is invoked when the effective base text direction has changed. That is, it is invoked

1. when the value of getResolvedBaseTextDirection() has changed, or
2. when the value of getComponentOrientation() has changed and the value of getResolvedBaseTextDirection() is IlvBidiUtil.CONTEXTUAL_DIRECTION.

Since:

JViews 8.8

getLabel

public final String getLabel()

Returns the label.

setLabel

public void setLabel(String label)

Sets a new label.

setFont

public void setFont(Font font)

Sets the font of this item. By default, an item is drawn using the font specified on the legend, so that all items are drawn with the same font. You should use this method if you want to have distinct fonts per items.

Overrides:

setFont in class JComponent

setForeground

public void setForeground(Color color)

Sets the text color of this item. By default, an item is drawn using the text color specified on the legend, so that all items are drawn with the same color. You should use this method if you want to have distinct colors per items.

Overrides:

setForeground in class JComponent

getTextBorder

public Border getTextBorder()

Returns the text border.

setTextBorder

public void setTextBorder(Border border)

Sets the text border.

isOpaqueText

public boolean isOpaqueText()

Returns whether the text is opaque.

setOpaqueText

public void setOpaqueText(boolean opaque)

Sets whether the text is opaque.

paintComponent

protected void paintComponent(Graphics g)

Draws the item.

Overrides:

paintComponent in class JComponent

drawSymbol

public void drawSymbol(Graphics g,
                       Rectangle symbolBounds)

Draws the symbol part of the item.

This default implementation does nothing. Subclasses should override this method.

Since:

JViews 8.1

drawLabel

public void drawLabel(Graphics g,
                      Point2D center)

Draws the label part of the item.

Since:

JViews 8.1

getLabelDimension

public Dimension getLabelDimension()

Returns the dimension of the label part of the item.

Since:

JViews 8.1

getPreferredSize

public Dimension getPreferredSize()

Returns the preferred size.

Overrides:

getPreferredSize in class JComponent

getMaximumSize

public Dimension getMaximumSize()

Returns the maximum size.

Overrides:

getMaximumSize in class JComponent

getMinimumSize

public Dimension getMinimumSize()

Returns the minimum size.

Overrides:

getMinimumSize in class JComponent

getMapArea

public IlvIMapArea getMapArea(IlvIMapDefinition mapdef,
                              IlvIMapAttributes attrs)

Returns the image map area definition of this item as an IlvIMapArea instance.

Since:

JViews 5.5

See Also:

IlvIMapArea

drawIntoHitmap

protected void drawIntoHitmap(IlvChartHitmapDefinition definition,
                              IlvChartHitmapAccumulator accumulator)

Draws this item as an object into the hitmap.

Parameters:

definition - The specification how to construct the hitmap.

accumulator - The object that accumulates objects in the hitmap.

Since:

JViews 8.7