ilog.views.chart

Class IlvChart.Area

java.lang.Object

ilog.views.chart.IlvChart.Area

Enclosing class:

IlvChart

public class IlvChart.Area
extends java.lang.Object

The component where the graphical representation of charts and scales are displayed. The chart area component is not designed to be instantiated. It is automatically created by the chart and can be accessed by the IlvChart#getChartArea method. This component is the place where all the drawing operations are performed (the graphical representations of the data themselves, and the decorations). This container also contains the Scales components. We can distinguish two areas within the chart area component:

• the drawing rectangle, where drawings are performed (both charts and scales). All the drawings occurring in the chart area are clipped by this rectangle. The drawing rectangle is equal to the component bounds minus its insets and can be retrieved by the IlvChart.Area#getDrawRect method.
• the plotting rectangle, the region where data is projected and displayed. The bounds of this rectangle are computed according to the drawing rectangle and the chart area internal margins. It can be retrieved by means of the IlvChart.Area#getPlotRect method.

The following figure shows the different parts of the chart area:

CSS example:

chartArea {
class : "ilog.views.chart.IlvChart.Area";
alignmentX : "2.0";
alignmentY : "2.0";
autoscrolls : "false";
background : "green";
backgroundPaint : "#000000";
border : "@#emptyBorder";
bottomMargin : "2";
debugGraphicsOptions : "2";
directRedrawEnabled : "false";
doubleBuffered : "false";
enabled : "false";
filledPlottingArea : "false";
focusable : "false";
focusCycleRoot : "false";
font : "sansserif-BOLD-8";
foreground : "green";
leftMargin : "2";
margins : "@#insets";
maximumSize : "0,0";
minimumSize : "0,0";
name : "<value>";
opaque : "false";
plotBackground : "#000000";
plotStyle : "@#ilvStyle";
preferredSize : "0,0";
requestFocusEnabled : "false";
rightMargin : "2";
toolTipText : "<value>";
topMargin : "2";
verifyInputWhenFocusTarget : "false";
visible : "false";
}

Property Summary

Properties

Modifier and Type	Property and Description
float	alignmentX Sets the vertical alignment.
float	alignmentY Sets the horizontal alignment.
boolean	autoscrolls Sets the autoscrolls property.
java.awt.Color	background Sets the background color of this component.
Paint	backgroundPaint Sets the background as a Paint.
Border	border Sets the border of this component.
int	bottomMargin Sets the bottom margin between the plotting rectangle and the chart area.
java.lang.String	class Default constructor.
int	debugGraphicsOptions Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.
boolean	directRedrawEnabled Sets the directRedraw property.
boolean	doubleBuffered Sets whether the this component should use a buffer to paint.
boolean	enabled Sets whether or not this component is enabled.
boolean	filledPlottingArea Sets whether the plotting area is filled.
boolean	focusable Sets the focusable state of this Component to the specified value.
boolean	focusCycleRoot Sets whether this Container is the root of a focus traversal cycle.
java.awt.Font	font Sets the font for this component.
java.awt.Color	foreground Sets the foreground color of this component.
int	leftMargin Sets the left margin between the plotting rectangle and the chart area.
java.awt.Insets	margins Sets the interior margins between the plotting rectangle and the chart area.
Dimension	maximumSize Sets the maximum size of this component to a constant value.
Dimension	minimumSize Sets the minimum size of this component to a constant value.
java.lang.String	name Sets the name of the component to the specified string.
boolean	opaque If true the component paints every pixel within its bounds.
Paint	plotBackground Sets the background paint of the plotting area.
IlvStyle	plotStyle Sets the style used to fill and outline the plotting area.
Dimension	preferredSize Sets the preferred size of this component.
boolean	requestFocusEnabled Provides a hint as to whether or not this JComponent should get focus.
int	rightMargin Sets the right margin between the plotting rectangle and the chart area.
java.lang.String	toolTipText Registers the text to display in a tool tip.
int	topMargin Sets the top margin between the plotting rectangle and the chart area.
boolean	verifyInputWhenFocusTarget Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus.
boolean	visible Makes the component visible or invisible.

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

class

public java.lang.String class

Default constructor.

CSS example: class : "ilog.views.chart.IlvChart.Area";

alignmentX

public float alignmentX

Sets the vertical alignment.

CSS example: alignmentX : "2.0";

alignmentY

public float alignmentY

Sets the horizontal alignment.

CSS example: alignmentY : "2.0";

autoscrolls

public boolean autoscrolls

Sets the autoscrolls property. If true mouse dragged events will be synthetically generated when the mouse is dragged outside of the component's bounds and mouse motion has paused (while the button continues to be held down). The synthetic events make it appear that the drag gesture has resumed in the direction established when the component's boundary was crossed. Components that support autoscrolling must handle mouseDragged events by calling scrollRectToVisible with a rectangle that contains the mouse event's location. All of the Swing components that support item selection and are typically displayed in a JScrollPane (JTable, JList, JTree, JTextArea, and JEditorPane) already handle mouse dragged events in this way. To enable autoscrolling in any other component, add a mouse motion listener that calls scrollRectToVisible. The default value of the autoScrolls property is false.

CSS example: autoscrolls : "false";

background

public java.awt.Color background

Sets the background color of this component.

CSS example: background : "green";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.

backgroundPaint

public Paint backgroundPaint

Sets the background as a Paint.

CSS example: backgroundPaint : "#000000";

border

public Border border

Sets the border of this component. The Border object is responsible for defining the insets for the component (overriding any insets set directly on the component) and for optionally rendering any border decorations within the bounds of those insets. Borders should be used (rather than insets) for creating both decorative and non-decorative (such as margins and padding) regions for a swing component. Compound borders can be used to nest multiple borders within a single component. This is a bound property.

CSS example: border : "@#emptyBorder";

See implementing class EmptyBorder for an example of implementing a border.

bottomMargin

public int bottomMargin

Sets the bottom margin between the plotting rectangle and the chart area.

CSS example: bottomMargin : "2";

See Also:

margins

debugGraphicsOptions

public int debugGraphicsOptions

Enables or disables diagnostic information about every graphics operation performed within the component or one of its children.

CSS example: debugGraphicsOptions : "2";

directRedrawEnabled

public boolean directRedrawEnabled

Sets the directRedraw property. When this property is set to true, redraw requests are automatically processed instead of being posted and executed by the drawing thread. The default value of this property is false.

CSS example: directRedrawEnabled : "false";

doubleBuffered

public boolean doubleBuffered

Sets whether the this component should use a buffer to paint. If set to true, all the drawing from this component will be done in an offscreen painting buffer. The offscreen painting buffer will the be copied onto the screen. Swings painting system always uses a maximum of one double buffer. If a Component is buffered and one of its ancestor is also buffered, the ancestor buffer will be used.

CSS example: doubleBuffered : "false";

enabled

public boolean enabled

Sets whether or not this component is enabled. A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input. Some components may alter their visual representation when they are disabled in order to provide feedback to the user that they cannot take input. Note: Disabling a component does not disable it's children. Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.

CSS example: enabled : "false";

filledPlottingArea

public boolean filledPlottingArea

Sets whether the plotting area is filled.

Note: The Bean property filledPlottingArea must not be specified together with the Bean property plotStyle.

CSS example: filledPlottingArea : "false";

focusable

public boolean focusable

Sets the focusable state of this Component to the specified value. This value overrides the Component's default focusability.

CSS example: focusable : "false";

focusCycleRoot

public boolean focusCycleRoot

Sets whether this Container is the root of a focus traversal cycle. Once focus enters a traversal cycle, typically it cannot leave it via focus traversal unless one of the up- or down-cycle keys is pressed. Normal traversal is limited to this Container, and all of this Container's descendants that are not descendants of inferior focus cycle roots. Note that a FocusTraversalPolicy may bend these restrictions, however. For example, ContainerOrderFocusTraversalPolicy supports implicit down-cycle traversal.

CSS example: focusCycleRoot : "false";

font

public java.awt.Font font

Sets the font for this component.

CSS example: font : "sansserif-BOLD-8";

foreground

public java.awt.Color foreground

Sets the foreground color of this component.

CSS example: foreground : "green";

A color can either be a string representing a color or else an octal or hexadecimal string that starts with the character "#" or else a comma separated "RGB" value where the integer values are in the range 0..255.

leftMargin

public int leftMargin

Sets the left margin between the plotting rectangle and the chart area.

CSS example: leftMargin : "2";

See Also:

margins

margins

public java.awt.Insets margins

Sets the interior margins between the plotting rectangle and the chart area. The margins parameter specifies the new margins. If this parameter is null, margins will be automatically computed.

CSS example: margins : "@#insets";

See implementing class Insets for an example of implementing a margins.

maximumSize

public Dimension maximumSize

Sets the maximum size of this component to a constant value. Subsequent calls to getMaximumSize will always return this value; the component's UI will not be asked to compute it. Setting the maximum size to null restores the default behavior.

CSS example: maximumSize : "0,0";

minimumSize

public Dimension minimumSize

Sets the minimum size of this component to a constant value. Subsequent calls to getMinimumSize will always return this value; the component's UI will not be asked to compute it. Setting the minimum size to null restores the default behavior.

CSS example: minimumSize : "0,0";

name

public java.lang.String name

Sets the name of the component to the specified string.

CSS example: name : "<value>";

opaque

public boolean opaque

If true the component paints every pixel within its bounds. Otherwise, the component may not paint some or all of its pixels, allowing the underlying pixels to show through. The default value of this property is false for JComponent. However, the default value for this property on most standard JComponent subclasses (such as JButton and JTree) is look-and-feel dependent.

CSS example: opaque : "false";

plotBackground

public Paint plotBackground

Sets the background paint of the plotting area.

Note: The Bean property plotBackground must not be specified together with the Bean property plotStyle.

CSS example: plotBackground : "#000000";

See Also:

plotStyle

plotStyle

public IlvStyle plotStyle

Sets the style used to fill and outline the plotting area.

Note: The Bean property plotStyle must not be specified together with the Bean properties plotBackground or filledPlottingArea.

CSS example: plotStyle : "@#ilvStyle";

See implementing class IlvStyle for an example of implementing a plotStyle.

preferredSize

public Dimension preferredSize

Sets the preferred size of this component. If preferredSize is null, the UI will be asked for the preferred size.

CSS example: preferredSize : "0,0";

requestFocusEnabled

public boolean requestFocusEnabled

Provides a hint as to whether or not this JComponent should get focus. This is only a hint, and it is up to consumers that are requesting focus to honor this property. This is typically honored for mouse operations, but not keyboard operations. For example, look and feels could verify this property is true before requesting focus during a mouse operation. This would often times be used if you did not want a mouse press on a JComponent to steal focus, but did want the JComponent to be traversable via the keyboard. If you do not want this JComponent focusable at all, use the setFocusable method instead.

CSS example: requestFocusEnabled : "false";

rightMargin

public int rightMargin

Sets the right margin between the plotting rectangle and the chart area.

CSS example: rightMargin : "2";

See Also:

margins

toolTipText

public java.lang.String toolTipText

Registers the text to display in a tool tip. The text displays when the cursor lingers over the component.

CSS example: toolTipText : "<value>";

topMargin

public int topMargin

Sets the top margin between the plotting rectangle and the chart area.

CSS example: topMargin : "2";

See Also:

margins

verifyInputWhenFocusTarget

public boolean verifyInputWhenFocusTarget

Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. The default is true. Set to false on components such as a Cancel button or a scrollbar, which should activate even if the input in the current focus owner is not "passed" by the input verifier for that component.

CSS example: verifyInputWhenFocusTarget : "false";

visible

public boolean visible

Makes the component visible or invisible. Overrides Component.setVisible.

CSS example: visible : "false";