![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.ChartFrame
com.aspose.cells.Title
public class Title
Encapsulates the object that represents the title of chart or axis.
Method Summary | |
---|---|
byte |
getBackgroundMode()
Gets the display mode of the background. |
Characters[] |
getCharacters()
Gets rich text formatting of this Title. |
Font |
getFont()
Gets a Font object of title. |
int |
getRotation()
Gets text rotation angel. |
java.lang.String |
getText()
Gets the text of a frame's title. |
int |
getTextDirection()
Gets the text direction type. |
int |
getTextHorizontalAlignment()
Gets the text horizontal alignment. |
int |
getTextVerticalAlignment()
Gets the text vertical alignment of text. |
int |
getX()
Gets the x coordinate of the Title's center in units of 1/4000 of the chart area. |
int |
getY()
Gets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
boolean |
isAutoScaleFont()
Check whether the text in the object changes font size when the object size changes. |
boolean |
isShadow()
Indicates if the frame has a shadow. |
void |
setAutoScaleFont(boolean isAutoScaleFont)
Set whether the text in the object changes font size when the object size changes. |
void |
setBackgroundMode(byte mode)
Sets the display mode of the background. |
void |
setCharacters(int startIndex,
int length,
Font font)
Performs rich text formatting. |
void |
setFont(Font font)
Sets a Font object of title. |
void |
setRotation(int rotation)
Sets text rotation angel.Must be between -90 and 90. |
void |
setShadow(boolean shadow)
Sets if the frame has a shadow. |
void |
setText(java.lang.String content)
Sets the text of a frame's title. |
void |
setTextDirection(int directionType)
Sets the text direction type. |
void |
setTextHorizontalAlignment(int textAlignmentType)
Sets the text horizontal alignment. |
void |
setTextVerticalAlignment(int textAlignmentType)
Sets the text vertical alignment of text. |
void |
setX(int x)
Sets the x coordinate of the Title's center in units of 1/4000 of the chart area. |
void |
setY(int y)
Sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. |
Methods inherited from class com.aspose.cells.ChartFrame |
---|
equals, getArea, getAreaOrNull, getBorder, getBorderOrNull |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public java.lang.String getText()
CellsException
- if chart has bean removed.public void setText(java.lang.String content)
content
- the text of a frame's title.
If null, will use automatically generated text string;
If "", means no Title shown
CellsException
- if chart has bean removed.public Characters[] getCharacters()
public void setCharacters(int startIndex, int length, Font font)
startIndex
- start index.length
- character counts.
If length is negative, all characters after the start index are formatted.
If length is 0, no characters is formatted.font
- font for the specified range. It can be null which means title's font is used.public Font getFont()
CellsException
- if chart has bean removed.public void setFont(Font font)
font
- a Font object.
CellsException
- if chart has bean removed.public boolean isAutoScaleFont()
public void setAutoScaleFont(boolean isAutoScaleFont)
isAutoScaleFont
- true if the text in the object changes font size when the object size changes.public int getTextHorizontalAlignment()
CellsException
- if chart has bean removed.setTextHorizontalAlignment(int)
public void setTextHorizontalAlignment(int textAlignmentType)
textAlignmentType
- the text horizontal alignment.
It could be one of the following values:
TextAlignmentType.LEFT |
TextAlignmentType.CENTER |
TextAlignmentType.RIGHT |
TextAlignmentType.JUSTIFY |
TextAlignmentType.DISTRIBUTED |
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if text alignment type is invalid.public int getTextVerticalAlignment()
CellsException
- if chart has bean removed.setTextVerticalAlignment(int)
public void setTextVerticalAlignment(int textAlignmentType)
textAlignmentType
- the text vertical alignment of text.
It could be one of the following values:
TextAlignmentType.TOP |
TextAlignmentType.CENTER |
TextAlignmentType.BOTTOM |
TextAlignmentType.JUSTIFY |
TextAlignmentType.DISTRIBUTED |
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if text alignment type is invalid.public void setRotation(int rotation)
rotation
- text rotation angel.
java.lang.IllegalArgumentException
- if rotation is not between -90 and 90.
CellsException
- if chart has bean removed.public int getRotation()
CellsException
- if chart has bean removed.public byte getBackgroundMode()
setBackgroundMode(byte)
public void setBackgroundMode(byte mode)
mode
- the display mode of the background. It could be one of following:
BackgroundMode.AUTOMATIC |
BackgroundMode.TRANSPARENT |
BackgroundMode.OPAQUE |
public int getX()
public void setX(int x)
x
- the x coordinate of the upper left corner.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if x > 4000;public int getY()
public void setY(int y)
y
- the y coordinate of the upper left corner.
CellsException
- if chart has bean removed.
java.lang.IllegalArgumentException
- if y > 4000;public int getTextDirection()
TextDirectionType
public void setTextDirection(int directionType)
directionType
- the direction type. * It must be one of the following values:
TextDirectionType.CONTEXT |
TextDirectionType.LEFT_TO_RIGHT |
TextDirectionType.RIGHT_TO_LEFT |
java.lang.IllegalArgumentException
- if the direction type is invalid.TextDirectionType
public boolean isShadow()
public void setShadow(boolean shadow)
shadow
- true if the frame has a shadow.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |