|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jxcell.ChartFormat
public class ChartFormat
The chart format class, providing information about chart formatting. This interface can be used to get and set formatting values on all elements within the chart. Certain formatting options only apply to certain parts of the chart. This object can be reused, so there is no need to create a new one for each object to be formatted.
Method Summary | |
---|---|
int |
getBackColor()
Returns the color used to display the pattern background. |
java.lang.String |
getCustomFormat()
Returns the number format. |
short |
getDataLabelPosition()
Returns the data label position value. |
java.lang.String |
getDataLabelSeparator()
Returns the data label separator value. |
short |
getDataLabelType()
Returns the data label type value. |
int |
getDataLabelTypes()
Returns the types of the data label. |
boolean |
getFontBold()
Returns whether the font is bold. |
int |
getFontColor()
Returns the color used to display the font. |
boolean |
getFontItalic()
Returns whether the font is italic. |
java.lang.String |
getFontName()
Returns the name of the font. |
int |
getFontSize()
Returns the size of the font in twips. |
boolean |
getFontUnderline()
Returns whether the font is underline. |
int |
getForeColor()
Returns the color used to display the pattern foreground. |
int |
getLineColor()
Gets the color. |
short |
getLineStyle()
Gets the style. |
int |
getLineWeight()
Gets the weight. |
int |
getMarkerBackground()
Returns the marker background color as an RGB value. |
int |
getMarkerForeground()
Returns the marker foreground color as an RGB value. |
int |
getMarkerSize()
Returns the marker size in twips. |
short |
getMarkerStyle()
Returns the marker style. |
int |
getOrientation()
|
int |
getPattern()
Gets the pattern. |
int |
getPatternFG()
|
boolean |
isFillAuto()
Returns whether fill is auto. |
boolean |
isFillShadow()
Returns whether the object has a shadow behind it. |
boolean |
isFontAutoScale()
Returns whether fonts are automatically scaled based on chart size. |
boolean |
isLineAuto()
return if the line auto |
boolean |
isLineNone()
if line is none |
boolean |
isLineShadow()
if the line is shadow. |
boolean |
isLinkedToDataSource()
Returns whether the object gets the value format from the data source. |
boolean |
isMarkerAuto()
Returns whether to use automatic formatting for a marker. |
boolean |
isPatternAuto()
|
boolean |
isSolid()
Returns whether fill is solid. |
boolean |
isValueFormatLinkedToDataSource()
Returns whether the object gets the value format from the data source. |
void |
setBackColor(int bg)
Sets the color used to display the pattern background. |
void |
setCustomFormat(java.lang.String format)
Sets the number format string |
void |
setDataLabelPosition(short sPosition)
Sets position of the data label. |
void |
setDataLabelSeparator(java.lang.String separator)
Sets the data label separator. |
void |
setDataLabelType(short sType)
Sets the type of data label to use. |
void |
setDataLabelTypes(int iType)
Sets the types of data label to use. |
void |
setFillAuto(boolean auto)
Sets whether fill is auto. |
void |
setFillShadow(boolean shadow)
Sets whether an object includes a shadow behind it. |
void |
setFontAutoScale(boolean autoscale)
Sets whether fonts are automatically scaled based on chart size. |
void |
setFontBold(boolean bold)
Sets the bold attribute of the font. |
void |
setFontColor(int color)
Sets the color used to display the font. |
void |
setFontItalic(boolean italic)
Sets the italic attribute of the font. |
void |
setFontName(java.lang.String name)
Sets the font name. |
void |
setFontSize(int size)
Sets the font size in twips. |
void |
setFontSizeInPoints(double point)
|
void |
setFontUnderline(boolean underline)
Sets the underline attribute of the font. |
void |
setForeColor(int fg)
Sets the color used to display the pattern foreground. |
void |
setGradient()
Sets the fill to Gradient. |
void |
setLineAuto()
set line auto |
void |
setLineColor(int color)
Sets the color. |
void |
setLineCustom()
set line custom style and weight |
void |
setLineNone()
set line none |
void |
setLineShadow(boolean shadow)
set the line shadow. |
void |
setLineStyle(short estyle)
Sets the style. |
void |
setLineWeight(int eweight)
Sets the weight. |
void |
setLinkedToDataSource(boolean link)
Sets whether the object gets the value format from the data source. |
void |
setMarkerAuto(boolean auto)
Sets the marker type to be assigned automatically. |
void |
setMarkerBackground(int iBackground)
Sets marker background color as an RGB value. |
void |
setMarkerForeground(int iForeground)
Sets marker foreground color as an RGB value. |
void |
setMarkerSize(int iSize)
Sets marker size in twips. |
void |
setMarkerStyle(short sStyle)
Sets marker style. |
void |
setOrientation(int orientation)
|
void |
setPattern(short pattern)
Sets the pattern. |
void |
setPatternAuto(boolean auto)
|
void |
setPatternFG(int fg)
|
void |
setSolid()
Sets the fill to solid. |
void |
setTextRotation(int rotation)
set the text rotation |
void |
setValueFormatLinkedToDataSource(boolean link)
Sets whether the object gets the value format from the data source. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final short LegendPlacementBottom
public static final short LegendPlacementCorner
public static final short LegendPlacementTop
public static final short LegendPlacementRight
public static final short LegendPlacementLeft
public static final short MarkerNone
public static final short MarkerSquare
public static final short MarkerDiamond
public static final short MarkerTriangle
public static final short MarkerX
public static final short MarkerStar
public static final short MarkerDowJonesClose
public static final short MarkerStdDeviation
public static final short MarkerCircle
public static final short MarkerPlus
public static final short MarkerDownTriangle
public static final short MarkerDowJonesOpen
public static final short DataLabelPositionDefault
public static final short DataLabelPositionOutside
public static final short DataLabelPositionInside
public static final short DataLabelPositionCenter
public static final short DataLabelPositionAxis
public static final short DataLabelPositionAbove
public static final short DataLabelPositionBelow
public static final short DataLabelPositionLeft
public static final short DataLabelPositionRight
public static final short DataLabelPositionAuto
public static final short DataLabelNone
public static final short DataLabelValue
public static final short DataLabelPercent
public static final short DataLabelCategory
public static final short DataLabelCategoryAndPercent
public static final short DataLabelBubbleSize
public static final short DataLabelSeriesNameMask
public static final short DataLabelXValueMask
public static final short DataLabelYValueMask
public static final short DataLabelPercentageMask
public static final short DataLabelSizeValueMask
public static final short LineNull
public static final short LineSolid
public static final short LineDash
public static final short LineDot
public static final short LineDashDot
public static final short LineDashDotDot
public static final short Hairline
public static final short Narrow
public static final short Medium
public static final short Wide
Method Detail |
---|
public short getDataLabelPosition()
public void setDataLabelPosition(short sPosition) throws java.lang.Exception
sPosition
- a short describing label position.
Data Label Position Constants.
DataLabelPositionOutside DataLabelPositionAbove DataLabelPositionAuto
DataLabelPositionAxis DataLabelPositionBelow DataLabelPositionCenter
DataLabelPositionDefault DataLabelPositionInside DataLabelPositionLeft
DataLabelPositionRight
java.lang.Exception
- if argument is invalid.public java.lang.String getDataLabelSeparator()
public void setDataLabelSeparator(java.lang.String separator)
separator
- a string specifying the data label separator.public short getDataLabelType()
public void setDataLabelType(short sType) throws java.lang.Exception
sType
- a constant designating a data label type.
Data Label Type Constants
DataLabelCategory DataLabelCategoryAndPercent DataLabelBubbleSize
DataLabelNone DataLabelValue DataLabelPercent
java.lang.Exception
- if argument is invalid.public int getDataLabelTypes()
public void setDataLabelTypes(int iType) throws java.lang.Exception
iType
- an integer designating the data label types, which are OR'd together.
Data Label Type Mask Constants
DataLabelSeriesNameMask DataLabelXValueMask DataLabelYValueMask
DataLabelNone DataLabelPercentageMask DataLabelSizeValueMask
java.lang.Exception
- if argument is invalid.public int getMarkerBackground()
public void setMarkerBackground(int iBackground)
iBackground
- an int that describes the border color as a four-byte integer in the format 0x00RRGGBB.public int getMarkerForeground()
public void setMarkerForeground(int iForeground)
iForeground
- an int that describes the border color as a four-byte integer in the format 0x00RRGGBB.public int getMarkerSize()
public void setMarkerSize(int iSize) throws java.lang.Exception
iSize
- an integer between 0 and 1440.
java.lang.Exception
- if argument is invalid.public short getMarkerStyle()
public void setMarkerStyle(short sStyle) throws java.lang.Exception
sStyle
- a constant designating the marker style.
Marker Style Constants
MarkerCircle MarkerDiamond MarkerDowJonesClose
MarkerDowJonesOpen MarkerDownTriangle MarkerPlus
MarkerSquare MarkerStar MarkerStdDeviation
MarkerTriangle MarkerX MarkerNone
java.lang.Exception
- if argument is invalid.public boolean isFillShadow()
public void setFillShadow(boolean shadow)
shadow
- true = add a shadow.public boolean isMarkerAuto()
public void setMarkerAuto(boolean auto)
auto
- true = marker type set automatically.public boolean isValueFormatLinkedToDataSource()
public void setValueFormatLinkedToDataSource(boolean link)
link
- true = set value format from data source.public boolean isFillAuto()
public void setFillAuto(boolean auto)
auto
- whether or not to fill auto.public int getBackColor()
public void setBackColor(int bg)
bg
- an integer describing the font color as a four-byte integer in the format 0x00RRGGBB.public int getForeColor()
public void setForeColor(int fg)
fg
- an integer describing the font color as a four-byte integer in the format 0x00RRGGBB.public int getPattern()
public void setPattern(short pattern) throws java.lang.Exception
pattern
-
java.lang.Exception
- exceptionpublic int getPatternFG()
public void setPatternFG(int fg)
public boolean isSolid()
public void setSolid()
public void setGradient()
public int getLineColor()
public void setLineColor(int color)
color
- the color.public boolean isLineAuto()
public void setLineAuto()
public boolean isLineNone()
public void setLineNone()
public void setLineCustom()
public short getLineStyle()
public void setLineStyle(short estyle)
estyle
- the style
style Constants
LineSolid LineDash LineDot
LineDashDot LineDashDotDotpublic int getLineWeight()
public void setLineWeight(int eweight)
eweight
- the weight
weight Constants
Hairline Narrow Medium
Widepublic boolean isLineShadow()
public void setLineShadow(boolean shadow)
shadow
- true to set line shadowpublic java.lang.String getFontName()
public void setFontName(java.lang.String name)
name
- a string that designates the font name.public int getFontSize()
public void setFontSize(int size)
size
- an integer indicating the font size.public boolean getFontItalic()
public void setFontItalic(boolean italic)
italic
- true = set font to italic.public boolean getFontUnderline()
public void setFontUnderline(boolean underline)
underline
- true = set font to underline.public boolean getFontBold()
public void setFontBold(boolean bold)
bold
- true = set font to bold.public int getFontColor()
public void setFontColor(int color)
color
- integer describing the font color as a four-byte integer in the format 0x00RRGGBB.public boolean isFontAutoScale()
public void setFontAutoScale(boolean autoscale)
autoscale
- true = set auto scale fonts.public boolean isLinkedToDataSource()
public void setLinkedToDataSource(boolean link)
link
- true = set value format from data source.public java.lang.String getCustomFormat()
public void setCustomFormat(java.lang.String format) throws java.lang.Exception
format
- the string defining the number format
java.lang.Exception
- if argument is invalid.public void setTextRotation(int rotation) throws java.lang.Exception
rotation
- rotation value
java.lang.Exception
- if argument is invalid.public void setFontSizeInPoints(double point) throws CellException
CellException
public int getOrientation()
public void setOrientation(int orientation) throws CellException
CellException
public boolean isPatternAuto()
public void setPatternAuto(boolean auto)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |