|
NetCharts Pro | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnetcharts.pro.common.NFBaseClass
netcharts.pro.common.NFLegendItem
public class NFLegendItem
The NFLegendItem represents a single item in a legend. This object is only used if the developer needs to explicitly specify each legend item. See NFLegend for more information.
Each legend item can have text, a symbol with border, and an associated line.
| Constructor Summary | |
|---|---|
NFLegendItem()
Constructs a default legend item object |
|
NFLegendItem(java.lang.String text,
int symbolType,
java.awt.Color symbolColor)
Constructs a legend item using the given text, symbol and symbol color. |
|
| Method Summary | |
|---|---|
java.lang.Object |
clone()
Clone this legend item. |
java.lang.String |
getCDL()
Generate CDL parameters representing this legend item |
java.awt.Color |
getFillColor()
Return symbol fill color |
NFFillPattern |
getFillPattern()
Return fill pattern |
java.awt.Color |
getLineColor()
Return line color |
int |
getLineType()
Return line type |
int |
getLineWidth()
Return line width |
int |
getSymbolShadowWidth()
Gets the legend item symbol's shadow width |
int |
getSymbolSize()
Return symbol size |
int |
getSymbolStyle()
Return symbol style |
int |
getSymbolType()
Return symbol type. |
java.lang.String |
getText()
Return legend item text |
void |
setCDL(java.lang.String cdl)
Configures this object from a CDL parameter representation. |
void |
setFillColor(java.awt.Color symbolColor)
Set symbol fill color |
void |
setFillPattern(NFFillPattern pattern)
Set the fill pattern |
void |
setIncludesShadowWidth(boolean includeShadowWidth)
Enables the legend item symbol's shadow width property. |
void |
setLineColor(java.awt.Color lineColor)
Set line color |
void |
setLineType(int lineType)
Set line type. |
void |
setLineWidth(int lineWidth)
Set line width. |
void |
setSymbolShadowWidth(int shadowWidth)
Sets the legend item symbol's shadow width. |
void |
setSymbolSize(int symbolSize)
Set symbol size. |
void |
setSymbolStyle(int symbolStyle)
Set symbol style. |
void |
setSymbolType(int symbolType)
Set symbol type. |
void |
setText(java.lang.String text)
Set legend item text |
java.lang.String |
toString()
Returns a new String object representing this legend item. |
| Methods inherited from class netcharts.pro.common.NFBaseClass |
|---|
getModified, getUserObject, setModified, setUserObject |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public NFLegendItem()
public NFLegendItem(java.lang.String text,
int symbolType,
java.awt.Color symbolColor)
text - The text of the legend item. May be the null string ("").symbolType - One of CIRCLE, SQUARE, DIAMOND, TRIANGLEUP, TRIANGLEDOWN,
CROSS, VRECTANGLE, HRECTANGLE, TARGET, BAR, TRIANGLEBAR, DIAMONDBAR, CYLINDER,
PIEVERTICAL, PIEHORIZONTAL.symbolColor - The fill color of the symbol.| Method Detail |
|---|
public java.lang.Object clone()
throws java.lang.CloneNotSupportedException
clone in class NFBaseClassjava.lang.CloneNotSupportedExceptionpublic void setText(java.lang.String text)
text - Text to display for this legend item.public java.lang.String getText()
public void setFillColor(java.awt.Color symbolColor)
color - Color of symbol fill.public java.awt.Color getFillColor()
public void setSymbolType(int symbolType)
CIRCLE, SQUARE, DIAMOND, TRIANGLEUP, TRIANGLEDOWN,
CROSS, VRECTANGLE, HRECTANGLE, TARGET, BAR, TRIANGLEBAR, DIAMONDBAR, CYLINDER,
PIEVERTICAL, PIEHORIZONTAL.If the value passed is not a valid symbol type an IllegalArgumentException will be thrown.
symbolType - Type of symbol to be shown alongside the text.public int getSymbolType()
public void setSymbolSize(int symbolSize)
symbolSize - Size (in pixels) of the symbol.public int getSymbolSize()
public void setFillPattern(NFFillPattern pattern)
pattern - Fill pattern to use.public NFFillPattern getFillPattern()
public void setSymbolStyle(int symbolStyle)
OUTLINED, FILLED, BOTHIf the value passed is not a valid symbol style an IllegalArgumentException will be thrown.
symbolStyle - The style of the symbol.public int getSymbolStyle()
public void setLineType(int lineType)
NONE, SOLID, DOTTED, DASHED, DOTDASHIf the value passed is not a valid line type an IllegalArgumentException will be thrown.
lineType - The type of line (if any) to be shown alongside the text.public int getLineType()
public void setLineWidth(int lineWidth)
lineWidth - Width of line (in pixels).public int getLineWidth()
public void setLineColor(java.awt.Color lineColor)
lineColor - public java.awt.Color getLineColor()
public void setSymbolShadowWidth(int shadowWidth)
shadowWidth - legend item symbol's shadow width in pixelspublic int getSymbolShadowWidth()
public void setCDL(java.lang.String cdl)
setCDL in interface NFCDLGeneratorcdl - CDL in the form: ("label", color, symbolType, symbolStyle,lineType, lineWidth, lineColor)public java.lang.String getCDL()
getCDL in interface NFCDLGenerator("label", color, symbolType, symbolStyle,lineType, lineWidth, lineColor)public java.lang.String toString()
toString in interface NFCDLGeneratortoString in class java.lang.Objectpublic void setIncludesShadowWidth(boolean includeShadowWidth)
includeShadowWidth - true to enable the legend item symbol's shadow width,
false otherwise
|
NetCharts Pro | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
| Visual Mining, Inc. | Copyright © Visual Mining, Inc. 1996 - 2018 |
Last Modified: Jan 7, 2018 |