com.spire.xls.charts
Class ChartTextArea

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.charts.ChartTextArea

All Implemented Interfaces:

IChartDataLabels, IChartTextArea, IFont, IOptimizedUpdate

public class ChartTextArea
extends XlsObject
implements IChartDataLabels

this class create Xls test document Text Area

Constructor Summary

ChartTextArea(IChartTextArea textarea, XlsWorkbook book)

Method Summary

java.awt.Font	generateNativeFont() Generates .Net font object corresponding to the current font.
ChartBackgroundMode	getBackgroundMode() Display mode of the background.
java.awt.Color	getColor() Gets font color.
java.lang.String	getDelimiter() Delimeter.
FontWrapper	getFont() Returns font impl for current font.
java.lang.String	getFontName() Returns or sets the font name.
IChartFrameFormat	getFrameFormat() Return format of the text area.
HorizontalAlignType	getHorizontalAlignType()
int	getIndex() Returns font index.
ExcelColors	getKnownColor() Returns or sets the primary color of the object, as shown in the following table.
java.lang.String	getNumberFormat() Gets or sets number format for the text area.
int	getNumberFormatIndex() Gets index to the number format.
OColor	getOColor() Returns textarea's color object.
java.lang.Object	getParent()
XlsWorkbook	getParentWorkbook() Returns parent workbook object.
DataLabelPositionType	getPosition() Represents data labels position.
boolean	getShowLeaderLines() Indicates whether Leader Lines is in data labels.
double	getSize() Returns the size of the font.
java.lang.String	getStrikethroughType() Strikethrough Type.
java.lang.String	getText() Area's text.
int	getTextRotationAngle() Text rotation angle.
FontUnderlineType	getUnderline() Returns or sets the type of underline applied to the font.
FontVertialAlignmentType	getVerticalAlignment() Gets / sets font vertical alignment.
float	getX()
float	getY()
boolean	hasBubbleSize() Indicates whether buble size is in data labels.
void	hasBubbleSize(boolean value) Indicates whether buble size is in data labels.
boolean	hasCategoryName() Indicates whether category name is in data labels.
void	hasCategoryName(boolean value) Indicates whether category name is in data labels.
boolean	hasDataLabels() Indicates whether contain dataLabels .
boolean	hasLegendKey() Indicates whether legend key is in data labels.
void	hasLegendKey(boolean value) Indicates whether legend key is in data labels.
boolean	hasPercentage() Indicates whether percentage is in data labels.
void	hasPercentage(boolean value) Indicates whether percentage is in data labels.
boolean	hasSeriesName() Indicates whether series name is in data labels.
void	hasSeriesName(boolean value) Indicates whether series name is in data labels.
boolean	hasValue() Indicates whether value is in data labels.
void	hasValue(boolean value) Indicates whether value is in data labels.
boolean	isAutoColor() Indicates whether color is automatically selected.
boolean	isAutoMode() True if background is set to automatic.
boolean	isBold() True if the font is bold.
void	isBold(boolean isBold) True if the font is bold.
boolean	isItalic() True if the font style is italic.
void	isItalic(boolean value) True if the font style is italic.
boolean	isShowLabelPercent() Indicates whether to show category label and value as percentage.
void	isShowLabelPercent(boolean value) Indicates whether to show category label and value as percentage.
boolean	isStrikethrough() True if the font is struck through with a horizontal line.
void	isStrikethrough(boolean value) True if the font is struck through with a horizontal line.
boolean	isSubscript() True if the font is formatted as subscript.
void	isSubscript(boolean value) True if the font is formatted as subscript.
boolean	isSuperscript() True if the font is formatted as superscript.
void	isSuperscript(boolean value) True if the font is formatted as superscript.
boolean	isTrend() Indicates if current text assign to trend object.
void	isTrend(boolean value) Indicates if current text assign to trend object.
void	setBackgroundMode(ChartBackgroundMode value) Display mode of the background.
void	setColor(java.awt.Color color) Sets font color.
void	setDelimiter(java.lang.String value) Delimeter.
void	setFont(ExcelFont font) Sets internal font according to the font.
void	setFontName(java.lang.String value) Returns or sets the font name.
void	setHorizontalAlignType(HorizontalAlignType value)
void	setKnownColor(ExcelColors value) Returns or sets the primary color of the object, as shown in the following table.
void	setNumberFormat(java.lang.String value) Gets or sets number format for the text area.
void	setPosition(DataLabelPositionType value) Represents data labels position.
void	setSize(double size) Sets the size of the font.
void	setStrikethroughType(java.lang.String value) Strikethrough Type.
void	setText(java.lang.String value) Area's text.
void	setTextRotationAngle(int textRotationAngle) Sets text rotation angle.
void	setUnderline(FontUnderlineType value) Returns or sets the type of underline applied to the font.
void	setVerticalAlignment(FontVertialAlignmentType value) Gets / sets font vertical alignment.
void	setX(float value)
void	setY(float value)

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Methods inherited from interface com.spire.xls.core.IChartDataLabels

setShowLeaderLines

Methods inherited from interface com.spire.xls.core.interfacess.IOptimizedUpdate

beginUpdate, endUpdate

Constructor Detail

ChartTextArea

public ChartTextArea(IChartTextArea textarea,
                     XlsWorkbook book)

Method Detail

getText

public java.lang.String getText()

Area's text.

Specified by:

getText in interface IChartTextArea

setText

public void setText(java.lang.String value)

Area's text.

getTextRotationAngle

public int getTextRotationAngle()

Text rotation angle.

Specified by:

getTextRotationAngle in interface IChartTextArea

setTextRotationAngle

public void setTextRotationAngle(int textRotationAngle)

Sets text rotation angle.

getFrameFormat

public IChartFrameFormat getFrameFormat()

Return format of the text area.

Specified by:

getFrameFormat in interface IChartTextArea

getBackgroundMode

public ChartBackgroundMode getBackgroundMode()

Display mode of the background.

Specified by:

getBackgroundMode in interface IChartTextArea

setBackgroundMode

public void setBackgroundMode(ChartBackgroundMode value)

Display mode of the background.

isAutoMode

public boolean isAutoMode()

True if background is set to automatic.

Specified by:

isAutoMode in interface IChartTextArea

getParent

public java.lang.Object getParent()

Overrides:

getParent in class XlsObject

isBold

public boolean isBold()

True if the font is bold. Read boolean.

Specified by:

isBold in interface IFont

isBold

public void isBold(boolean isBold)

True if the font is bold. Write boolean.

Specified by:

isBold in interface IFont

getKnownColor

public ExcelColors getKnownColor()

Returns or sets the primary color of the object, as shown in the following table. Use the RGB function to create a color value. Read / write Integer.

Specified by:

getKnownColor in interface IFont

setKnownColor

public void setKnownColor(ExcelColors value)

Returns or sets the primary color of the object, as shown in the following table. Use the RGB function to create a color value. Read / write Integer.

Specified by:

setKnownColor in interface IFont

getColor

public java.awt.Color getColor()

Gets font color. Searches for the closestes color in the workbook palette.

Specified by:

getColor in interface IFont

setColor

public void setColor(java.awt.Color color)

Sets font color. Searches for the closestes color in the workbook palette.

Specified by:

setColor in interface IFont

isItalic

public boolean isItalic()

True if the font style is italic. Read / write Boolean.

Specified by:

isItalic in interface IFont

isItalic

public void isItalic(boolean value)

True if the font style is italic. Read / write Boolean.

Specified by:

isItalic in interface IFont

getSize

public double getSize()

Returns the size of the font. Read / write Variant.

Specified by:

getSize in interface IFont

setSize

public void setSize(double size)

Sets the size of the font.

Specified by:

setSize in interface IFont

isStrikethrough

public boolean isStrikethrough()

True if the font is struck through with a horizontal line. Read / write Boolean

Specified by:

isStrikethrough in interface IFont

isStrikethrough

public void isStrikethrough(boolean value)

True if the font is struck through with a horizontal line. Read / write Boolean

Specified by:

isStrikethrough in interface IFont

isSubscript

public boolean isSubscript()

True if the font is formatted as subscript. False by default. Read / write Boolean.

Specified by:

isSubscript in interface IFont

isSubscript

public void isSubscript(boolean value)

True if the font is formatted as subscript. False by default. Read / write Boolean.

Specified by:

isSubscript in interface IFont

getStrikethroughType

public java.lang.String getStrikethroughType()

Strikethrough Type. Read / write sngStrike dblStrike

Specified by:

getStrikethroughType in interface IFont

setStrikethroughType

public void setStrikethroughType(java.lang.String value)

Strikethrough Type. Read / write sngStrike dblStrike

Specified by:

setStrikethroughType in interface IFont

isSuperscript

public boolean isSuperscript()

True if the font is formatted as superscript. False by default. Read/write Boolean

Specified by:

isSuperscript in interface IFont

isSuperscript

public void isSuperscript(boolean value)

True if the font is formatted as superscript. False by default. Read/write Boolean

Specified by:

isSuperscript in interface IFont

getUnderline

public FontUnderlineType getUnderline()

Returns or sets the type of underline applied to the font. Can be one of the following FontUnderlineTypeStyle constants. Read / write FontUnderlineType.

Specified by:

getUnderline in interface IFont

setUnderline

public void setUnderline(FontUnderlineType value)

Returns or sets the type of underline applied to the font. Can be one of the following FontUnderlineTypeStyle constants. Read / write FontUnderlineType.

Specified by:

setUnderline in interface IFont

getFontName

public java.lang.String getFontName()

Returns or sets the font name. Read / write string.

Specified by:

getFontName in interface IFont

setFontName

public void setFontName(java.lang.String value)

Returns or sets the font name. Read / write string.

Specified by:

setFontName in interface IFont

getVerticalAlignment

public FontVertialAlignmentType getVerticalAlignment()

Gets / sets font vertical alignment.

Specified by:

getVerticalAlignment in interface IFont

setVerticalAlignment

public void setVerticalAlignment(FontVertialAlignmentType value)

Gets / sets font vertical alignment.

Specified by:

setVerticalAlignment in interface IFont

isAutoColor

public boolean isAutoColor()

Indicates whether color is automatically selected. Read-only.

Specified by:

isAutoColor in interface IFont

generateNativeFont

public java.awt.Font generateNativeFont()

Generates .Net font object corresponding to the current font.

Specified by:

generateNativeFont in interface IFont

Returns:

Generated .Net font.

getOColor

public OColor getOColor()

Returns textarea's color object. Read-only.

getDelimiter

public java.lang.String getDelimiter()

Delimeter.

Specified by:

getDelimiter in interface IChartDataLabels

setDelimiter

public void setDelimiter(java.lang.String value)

Delimeter.

Specified by:

setDelimiter in interface IChartDataLabels

hasBubbleSize

public boolean hasBubbleSize()

Indicates whether buble size is in data labels.

Specified by:

hasBubbleSize in interface IChartDataLabels

hasBubbleSize

public void hasBubbleSize(boolean value)

Indicates whether buble size is in data labels.

Specified by:

hasBubbleSize in interface IChartDataLabels

hasCategoryName

public boolean hasCategoryName()

Indicates whether category name is in data labels.

Specified by:

hasCategoryName in interface IChartDataLabels

hasCategoryName

public void hasCategoryName(boolean value)

Indicates whether category name is in data labels.

Specified by:

hasCategoryName in interface IChartDataLabels

hasLegendKey

public boolean hasLegendKey()

Indicates whether legend key is in data labels.

Specified by:

hasLegendKey in interface IChartDataLabels

hasLegendKey

public void hasLegendKey(boolean value)

Indicates whether legend key is in data labels.

Specified by:

hasLegendKey in interface IChartDataLabels

hasPercentage

public boolean hasPercentage()

Indicates whether percentage is in data labels.

Specified by:

hasPercentage in interface IChartDataLabels

hasPercentage

public void hasPercentage(boolean value)

Indicates whether percentage is in data labels.

Specified by:

hasPercentage in interface IChartDataLabels

hasSeriesName

public boolean hasSeriesName()

Indicates whether series name is in data labels.

Specified by:

hasSeriesName in interface IChartDataLabels

hasSeriesName

public void hasSeriesName(boolean value)

Indicates whether series name is in data labels.

Specified by:

hasSeriesName in interface IChartDataLabels

hasValue

public boolean hasValue()

Indicates whether value is in data labels.

Specified by:

hasValue in interface IChartDataLabels

hasValue

public void hasValue(boolean value)

Indicates whether value is in data labels.

Specified by:

hasValue in interface IChartDataLabels

getPosition

public DataLabelPositionType getPosition()

Represents data labels position.

Specified by:

getPosition in interface IChartDataLabels

setPosition

public void setPosition(DataLabelPositionType value)

Represents data labels position.

Specified by:

setPosition in interface IChartDataLabels

getShowLeaderLines

public boolean getShowLeaderLines()

Indicates whether Leader Lines is in data labels.

Specified by:

getShowLeaderLines in interface IChartDataLabels

getNumberFormat

public java.lang.String getNumberFormat()

Gets or sets number format for the text area.

Specified by:

getNumberFormat in interface IChartDataLabels

setNumberFormat

public void setNumberFormat(java.lang.String value)

Gets or sets number format for the text area.

Specified by:

setNumberFormat in interface IChartDataLabels

hasDataLabels

public boolean hasDataLabels()

Indicates whether contain dataLabels .

getHorizontalAlignType

public HorizontalAlignType getHorizontalAlignType()

setHorizontalAlignType

public void setHorizontalAlignType(HorizontalAlignType value)

getIndex

public int getIndex()

Returns font index. Read-only.

isShowLabelPercent

public boolean isShowLabelPercent()

Indicates whether to show category label and value as percentage.

isShowLabelPercent

public void isShowLabelPercent(boolean value)

Indicates whether to show category label and value as percentage.

isTrend

public boolean isTrend()

Indicates if current text assign to trend object.

isTrend

public void isTrend(boolean value)

Indicates if current text assign to trend object.

getNumberFormatIndex

public int getNumberFormatIndex()

Gets index to the number format. Read-only.

getParentWorkbook

public XlsWorkbook getParentWorkbook()

Returns parent workbook object.

getX

public float getX()

setX

public void setX(float value)

getY

public float getY()

setY

public void setY(float value)

setFont

public void setFont(ExcelFont font)

Sets internal font according to the font.

Parameters:

font - Font to set.

getFont

public FontWrapper getFont()

Returns font impl for current font. Read-only.