|
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.NFSymbol
netcharts.pro.common.lineset.NFLineSetSymbol
public class NFLineSetSymbol
The NFLineSetSymbol object extends NFSymbol to provide support for symbol outline color and width attributes. Additionally, developers may use the NFLineSetSymbol object to specify an image URL to be used in place of the symbol.
This object is used extensively to represent symbols in the NFLinechart, NFCombochart, NFXYchart, and NFStripchart.
| Field Summary | |
|---|---|
static int |
IMAGE
Image Symbol type |
| Fields inherited from class netcharts.pro.common.NFSymbol |
|---|
BOTH, CIRCLE, CROSS, DIAMOND, FILLED, HRECTANGLE, NONE, OUTLINED, SQUARE, styleMap, TARGET, TRIANGLEDOWN, TRIANGLEUP, typeMap, VRECTANGLE |
| Constructor Summary | |
|---|---|
NFLineSetSymbol()
Constructs a default symbol object |
|
NFLineSetSymbol(int type,
int size)
Constructs a symbol object with the specified symbol type, size, and FILLED style. |
|
NFLineSetSymbol(int type,
int size,
int style)
Constructs a symbol object with the specified symbol type, size, and style. |
|
| Method Summary | |
|---|---|
java.lang.String |
getCDL()
Generate CDL parameters representing this symbol |
java.lang.String |
getCDL(java.lang.StringBuffer sb,
boolean includeParens)
Append CDL parameters representing this symbol to the given StringBuffer. |
java.awt.Color |
getColor()
Gets the symbol color. |
java.awt.Image |
getImage()
Gets the data symbol image. |
java.lang.String |
getImageURL()
Gets the data symbol image. |
java.awt.Color |
getOutlineColor()
Gets the symbol outline color. |
int |
getOutlineWidth()
Gets the symbol outline width. |
int |
getShadowWidth()
Gets symbol's shadow width |
void |
setCDL(java.lang.String cdl)
Configures this object from a CDL parameter representation. |
int |
setCDL(java.lang.String[] elements,
int offset)
Configures this object from a CDL parameter representation. |
void |
setColor(java.awt.Color color)
Sets the symbol color. |
void |
setImage(java.awt.Image image)
Sets the image to use for the data symbol. |
void |
setImageURL(java.lang.String imageURL)
Sets the image to use for the data symbol. |
void |
setIncludesShadowWidth(boolean includesShadowWidth)
Enables the line set symbol's shadow width property. |
void |
setOutlineColor(java.awt.Color outlineColor)
Sets the symbol outline color. |
void |
setOutlineWidth(int outlineWidth)
Sets the symbol outline width. |
void |
setShadowWidth(int shadowWidth)
Sets the data symbol's shadow width. |
void |
setType(int type)
Sets the symbol type to use for the data. |
void |
setUsesImage(boolean usesImage)
Enables the usage of an image based symbol. |
java.lang.String |
toString()
Returns a new String object representing this symbol. |
| Methods inherited from class netcharts.pro.common.NFSymbol |
|---|
getSize, getStyle, getType, setCDL, setSize, setStyle |
| Methods inherited from class netcharts.pro.common.NFBaseClass |
|---|
clone, getModified, getUserObject, setModified, setUserObject |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final int IMAGE
| Constructor Detail |
|---|
public NFLineSetSymbol()
public NFLineSetSymbol(int type,
int size)
type - One of CIRCLE, SQUARE, DIAMOND, TRIANGLEUP, TRIANGLEDOWN,
CROSS, VRECTANGLE, HRECTANGLE, TARGET, IMAGE. size - Symbol size in pixels
public NFLineSetSymbol(int type,
int size,
int style)
type - One of CIRCLE, SQUARE, DIAMOND, TRIANGLEUP, TRIANGLEDOWN,
CROSS, VRECTANGLE, HRECTANGLE, TARGET, IMAGE. size - Symbol size in pixelsstyle - One of FILLED, OUTLINED, BOTH| Method Detail |
|---|
public void setColor(java.awt.Color color)
setColor in interface NFSetSymbolcolor - Color to use for the symbol.public java.awt.Color getColor()
getColor in interface NFSetSymbolpublic void setOutlineColor(java.awt.Color outlineColor)
setOutlineColor in interface NFSetSymboloutlineColor - Color to use for symbol outline.public java.awt.Color getOutlineColor()
getOutlineColor in interface NFSetSymbolpublic void setOutlineWidth(int outlineWidth)
setOutlineWidth in interface NFSetSymboloutlineWidth - Width, in pixels of the symbol outline.public int getOutlineWidth()
getOutlineWidth in interface NFSetSymbolpublic void setImageURL(java.lang.String imageURL)
image - A URL string representing the location of an
appropriate image (.gif, .png, .jpg).public void setImage(java.awt.Image image)
image - A java.awt.Image representing the appropriate image (.gif, .png, .jpg).public java.lang.String getImageURL()
public java.awt.Image getImage()
public void setType(int type)
setType in interface NFSetSymbolsetType in class NFSymboltype - One of
CIRCLE, SQUARE, DIAMOND, TRIANGLEUP, TRIANGLEDOWN,
CROSS, VRECTANGLE, HRECTANGLE, TARGET, IMAGE..public void setShadowWidth(int shadowWidth)
shadowWidth - symbol's shadow width in pixelspublic int getShadowWidth()
public java.lang.String toString()
toString in interface NFCDLGeneratortoString in class NFSymbolpublic java.lang.String getCDL()
getCDL in interface NFCDLGeneratorgetCDL in class NFSymbol(symbolType, symbolSize, symbolStyle, outlineColor, outlineWidth, imageURL)
public java.lang.String getCDL(java.lang.StringBuffer sb,
boolean includeParens)
getCDL in class NFSymbolsb - Target buffer to append the CDL parametersincludeParens - If true, this will cause the parameters to be delimited
with parenthesis.public void setCDL(java.lang.String cdl)
setCDL in interface NFCDLGeneratorsetCDL in class NFSymbolcdl - CDL in the form: (symbolType, symbolSize, symbolStyle, outlineColor, outlineWidth, imageURL)
public int setCDL(java.lang.String[] elements,
int offset)
setCDL in class NFSymbolelements - Array of parameter elements. This array is expected
to contain consecutive elements containing symbolType, symbolSize,
symbolStyle, outlineColor, outlineWidth, imageURL information.offset - Offset into the elements array.public void setUsesImage(boolean usesImage)
usesImage - true to use an image based symbol, false otherwise.public void setIncludesShadowWidth(boolean includesShadowWidth)
includeShadowWidth - true to enable the line set 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 |