|
Chart FX for Java 6.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectSoftwareFX.ChartFX.HighlightGridSettings
Provides access to the HighlightGridSettings object.
This class is derived from the HighlightToolSettings class. The supported members are used specifically when customizing highlighting options for the DataEditor object. For information regarding customizing other chart tools, please refer to the HighlightToolSettings
class.
Constructor Summary | |
HighlightGridSettings()
|
Method Summary | |
java.awt.Color |
getBorderColor()
Gets or sets the BorderColor for the hightlighted point's grid cell in the data editor. |
java.awt.Color |
getColor()
Gets or sets the Color for the hightlighted grid cell in the data editor. |
int |
getDataCells()
Gets or sets a value indicating the what will be highlighted in the chart when a cell in the DataEditor is highlighted. |
int |
getFontStyle()
Gets or sets additional font attributes to a highlighted DataEditor cell. |
java.awt.Color |
getTextColor()
Gets or sets the color for text of a highlighted DataEditor cell. |
boolean |
isEnabled()
Gets or sets a value indicating whether the highlighting feature will be enabled in the selected Chart FX Tool. |
boolean |
isImmediate()
Gets or sets a value indicating that the highlight action will occur immediately. |
void |
setBorderColor(java.awt.Color value)
Gets or sets the BorderColor for the hightlighted point's grid cell in the data editor. |
void |
setColor(java.awt.Color value)
Gets or sets the Color for the hightlighted grid cell in the data editor. |
void |
setDataCells(int value)
Gets or sets a value indicating the what will be highlighted in the chart when a cell in the DataEditor is highlighted. |
void |
setEnabled(boolean value)
Gets or sets a value indicating whether the highlighting feature will be enabled in the selected Chart FX Tool. |
void |
setFontStyle(int value)
Gets or sets additional font attributes to a highlighted DataEditor cell. |
void |
setImmediate(boolean value)
Gets or sets a value indicating that the highlight action will occur immediately. |
void |
setTextColor(java.awt.Color value)
Gets or sets the color for text of a highlighted DataEditor cell. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public HighlightGridSettings()
Method Detail |
public java.awt.Color getBorderColor()
Gets or sets the BorderColor for the hightlighted point's grid cell in the data editor.
This property is used to set a border color for a highlighted cell in the data editor.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
HighlightToolSettings.setEnabled(boolean)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public java.awt.Color getColor()
Gets or sets the Color for the hightlighted grid cell in the data editor.
This property is used to set the color for a highlighted cell in the data editor.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public int getDataCells()
Gets or sets a value indicating the what will be highlighted in the chart when a cell in the DataEditor is highlighted.
HighlightData :
HighlightDataValue | Description |
NONE | No chart element will be highlighted. |
AUTO | Chart FX Automatically used defaults for highlighting. |
MARKER | Only Markers will be highlighted. |
SERIES | Only Series will be highlighted. |
Not only will the cells in the DataEditor be highlighted when a series is highlighted in the chart, but if a cell is highlighted in the DataEditor, the series/point will be highlighted in the chart. This property is used to control which chart elements will display the highlighted status within the chart.
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setTextColor(java.awt.Color)
public int getFontStyle()
Gets or sets additional font attributes to a highlighted DataEditor cell.
FontStyle :
Specifies style information applied to text.Value | Description |
BOLD | Bold text. |
ITALIC | Italic text. |
REGULAR | Regular text. |
STRIKEOUT | Text with a line through the middle. |
UNDERLINE | Underline text. |
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
Use the setDataCells(int)
property to control how the chart elements will be displayed with a cell in the DataEditor is highlighted.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public java.awt.Color getTextColor()
Gets or sets the color for text of a highlighted DataEditor cell.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
Use the setDataCells(int)
property to control how the chart elements will be displayed with a cell in the DataEditor is highlighted.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
HighlightToolSettings
public boolean isEnabled()
Gets or sets a value indicating whether the highlighting feature will be enabled in the selected Chart FX Tool.
The Highlight property of the chart tools (data editor, series legend, values legend, etc.) exposes this property. Setting the Enabled property to false will disable the highlight feature for the specified tool.
The HighlightGridSettings
class may be used to customize the highlight attributes for the DataEditor object.
HighlightGridSettings
,
DataEditor
,
LegendBox
public boolean isImmediate()
Gets or sets a value indicating that the highlight action will occur immediately.
When this property is set to true, the highlight action will occur right when a user hovers the mouse cursor over a chart element. The default behavior is a short pause.
HighlightSettings
public void setBorderColor(java.awt.Color value)
Gets or sets the BorderColor for the hightlighted point's grid cell in the data editor.
This property is used to set a border color for a highlighted cell in the data editor.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
HighlightToolSettings.setEnabled(boolean)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public void setColor(java.awt.Color value)
Gets or sets the Color for the hightlighted grid cell in the data editor.
This property is used to set the color for a highlighted cell in the data editor.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public void setDataCells(int value)
Gets or sets a value indicating the what will be highlighted in the chart when a cell in the DataEditor is highlighted.
HighlightData :
HighlightDataValue | Description |
NONE | No chart element will be highlighted. |
AUTO | Chart FX Automatically used defaults for highlighting. |
MARKER | Only Markers will be highlighted. |
SERIES | Only Series will be highlighted. |
Not only will the cells in the DataEditor be highlighted when a series is highlighted in the chart, but if a cell is highlighted in the DataEditor, the series/point will be highlighted in the chart. This property is used to control which chart elements will display the highlighted status within the chart.
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setTextColor(java.awt.Color)
public void setEnabled(boolean value)
Gets or sets a value indicating whether the highlighting feature will be enabled in the selected Chart FX Tool.
The Highlight property of the chart tools (data editor, series legend, values legend, etc.) exposes this property. Setting the Enabled property to false will disable the highlight feature for the specified tool.
The HighlightGridSettings
class may be used to customize the highlight attributes for the DataEditor object.
HighlightGridSettings
,
DataEditor
,
LegendBox
public void setFontStyle(int value)
Gets or sets additional font attributes to a highlighted DataEditor cell.
FontStyle :
Specifies style information applied to text.Value | Description |
BOLD | Bold text. |
ITALIC | Italic text. |
REGULAR | Regular text. |
STRIKEOUT | Text with a line through the middle. |
UNDERLINE | Underline text. |
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
Use the setDataCells(int)
property to control how the chart elements will be displayed with a cell in the DataEditor is highlighted.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
setTextColor(java.awt.Color)
,
HighlightToolSettings
public void setImmediate(boolean value)
Gets or sets a value indicating that the highlight action will occur immediately.
When this property is set to true, the highlight action will occur right when a user hovers the mouse cursor over a chart element. The default behavior is a short pause.
HighlightSettings
public void setTextColor(java.awt.Color value)
Gets or sets the color for text of a highlighted DataEditor cell.
The setBorderColor(java.awt.Color)
property may be used to configure the border color for the highlighted grid cell.
The HighlightToolSettings.setEnabled(boolean)
property must be configured to true in order for the configuration of this property to affect the chart.
The setColor(java.awt.Color)
property may be used to configure the background color for the highlighted grid cell.
Use the setDataCells(int)
property to control how the chart elements will be displayed with a cell in the DataEditor is highlighted.
HighlightToolSettings.setEnabled(boolean)
,
setBorderColor(java.awt.Color)
,
setColor(java.awt.Color)
,
setDataCells(int)
,
HighlightToolSettings
|
http://www.softwarefx.com | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |