com.aspose.cells

Class ChartTextFrame

java.lang.Object

com.aspose.cells.ChartFrame

com.aspose.cells.ChartTextFrame

Direct Known Subclasses:

DataLabels, DisplayUnitLabel, Legend, Title

public class ChartTextFrame
extends ChartFrame

Encapsulates the object that represents the frame object which contains text.

Method Summary

Methods

Modifier and Type	Method and Description
FontSetting	characters(int startIndex, int length) Returns a Characters object that represents a range of characters within the text.
int	getDirectionType() Gets the direction of text.
java.lang.String	getLinkedSource() Gets a reference to the worksheet.
int	getReadingOrder() Represents text reading order.
int	getRotationAngle() Represents text rotation angle.
java.lang.String	getText() Gets the text of a frame's title.
int	getTextDirection() Deprecated. Use ChartTextFrame.ReadingOrder property instead.
int	getTextHorizontalAlignment() Gets the text horizontal alignment.
int	getTextVerticalAlignment() Gets the text vertical alignment of text.
boolean	isAutomaticRotation() Indicates whether the text of the chart is automatically rotated.
boolean	isAutoText() Indicates the text is auto generated.
boolean	isDeleted() Indicates whether this data labels is deleted.
boolean	isResizeShapeToFitText() Gets whether a shape should be auto-fit to fully contain the text described within it.
boolean	isTextWrapped() Gets a value indicating whether the text is wrapped.
void	setAutoText(boolean value) Indicates the text is auto generated.
void	setDeleted(boolean value) Indicates whether this data labels is deleted.
void	setDirectionType(int value) Sets the direction of text.
void	setLinkedSource(java.lang.String value) Sets a reference to the worksheet.
void	setReadingOrder(int value) Represents text reading order.
void	setResizeShapeToFitText(boolean value) Sets whether a shape should be auto-fit to fully contain the text described within it.
void	setRotationAngle(int value) Represents text rotation angle.
void	setText(java.lang.String value) Sets the text of a frame's title.
void	setTextDirection(int value) Deprecated. Use ChartTextFrame.ReadingOrder property instead.
void	setTextHorizontalAlignment(int value) Sets the text horizontal alignment.
void	setTextVerticalAlignment(int value) Sets the text vertical alignment of text.
void	setTextWrapped(boolean value) Sets a value indicating whether the text is wrapped.

Methods inherited from class com.aspose.cells.ChartFrame

getArea, getAutoScaleFont, getBackground, getBackgroundMode, getBorder, getChart, getDefaultHeight, getDefaultHeightRatioToChart, getDefaultWidth, getDefaultWidthRatioToChart, getDefaultX, getDefaultXRatioToChart, getDefaultY, getDefaultYRatioToChart, getFont, getHeight, getHeightPixel, getHeightRatioToChart, getShadow, getShapeProperties, getTextFont, getTextOptions, getWidth, getWidthPixel, getWidthRatioToChart, getX, getXPixel, getXRatioToChart, getY, getYPixel, getYRatioToChart, isAutomaticSize, isDefaultPosBeSet, isInnerMode, setAutomaticSize, setAutoScaleFont, setBackground, setBackgroundMode, setHeight, setHeightPixel, setHeightRatioToChart, setInnerMode, setPositionAuto, setShadow, setWidth, setWidthPixel, setWidthRatioToChart, setX, setXPixel, setXRatioToChart, setY, setYPixel, setYRatioToChart

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAutoText

public boolean isAutoText()

Indicates the text is auto generated.

setAutoText

public void setAutoText(boolean value)

Indicates the text is auto generated.

isDeleted

public boolean isDeleted()

Indicates whether this data labels is deleted.

setDeleted

public void setDeleted(boolean value)

Indicates whether this data labels is deleted.

getTextHorizontalAlignment

public int getTextHorizontalAlignment()

Gets the text horizontal alignment.

See TextAlignmentType.

setTextHorizontalAlignment

public void setTextHorizontalAlignment(int value)

Sets the text horizontal alignment.

See TextAlignmentType.

getTextVerticalAlignment

public int getTextVerticalAlignment()

Gets the text vertical alignment of text.

See TextAlignmentType.

setTextVerticalAlignment

public void setTextVerticalAlignment(int value)

Sets the text vertical alignment of text.

See TextAlignmentType.

getRotationAngle

public int getRotationAngle()

Represents text rotation angle.

Remarks

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

setRotationAngle

public void setRotationAngle(int value)

Represents text rotation angle.

Remarks

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

isAutomaticRotation

public boolean isAutomaticRotation()

Indicates whether the text of the chart is automatically rotated.

characters

public FontSetting characters(int startIndex,
                     int length)

Returns a Characters object that represents a range of characters within the text.

Parameters:

startIndex - The index of the start of the character.

length - The number of characters.

Returns:

Characters object.

getText

public java.lang.String getText()

Gets the text of a frame's title.

setText

public void setText(java.lang.String value)

Sets the text of a frame's title.

getLinkedSource

public java.lang.String getLinkedSource()

Gets a reference to the worksheet.

setLinkedSource

public void setLinkedSource(java.lang.String value)

Sets a reference to the worksheet.

getTextDirection

public int getTextDirection()

Deprecated. Use ChartTextFrame.ReadingOrder property instead.

Represents text reading order.

See TextDirectionType.

Remarks

NOTE: This member is now obsolete. Instead, please use ChartTextFrame.ReadingOrder property. This property will be removed 12 months later since March 2020. Aspose apologizes for any inconvenience you may have experienced.

setTextDirection

public void setTextDirection(int value)

Deprecated. Use ChartTextFrame.ReadingOrder property instead.

Represents text reading order.

See TextDirectionType.

Remarks

NOTE: This member is now obsolete. Instead, please use ChartTextFrame.ReadingOrder property. This property will be removed 12 months later since March 2020. Aspose apologizes for any inconvenience you may have experienced.

getReadingOrder

public int getReadingOrder()

Represents text reading order.

See TextDirectionType.

setReadingOrder

public void setReadingOrder(int value)

Represents text reading order.

See TextDirectionType.

getDirectionType

public int getDirectionType()

Gets the direction of text.

See ChartTextDirectionType.

setDirectionType

public void setDirectionType(int value)

Sets the direction of text.

See ChartTextDirectionType.

isTextWrapped

public boolean isTextWrapped()

Gets a value indicating whether the text is wrapped.

setTextWrapped

public void setTextWrapped(boolean value)

Sets a value indicating whether the text is wrapped.

isResizeShapeToFitText

public boolean isResizeShapeToFitText()

Gets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.

setResizeShapeToFitText

public void setResizeShapeToFitText(boolean value)

Sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.