Drag[en]gine Script Module DragonScript Script API  1.0
STDStyle Class Reference

Styled text definition style. More...

Inheritance diagram for STDStyle:

Classes

enum  eTextAlignment
 Text alignment. More...
 

Public Member Functions

int getAlignment ()
 Alignment. More...
 
Color getBackgroundColor ()
 Background color. More...
 
int getCharacterSpacing ()
 Spacing between characters in pixels. More...
 
int getFirstLineIndent ()
 Indention of the first line in pixels. More...
 
Font getFont ()
 Font. More...
 
int getLineSpacing ()
 Spacing between lines in pixels. More...
 
RectArea getMargins ()
 Margins in pixels. More...
 
String getName ()
 Name of style. More...
 
Color getTextColor ()
 Text color. More...
 
STDStyle new (String name)
 Create style. More...
 
STDStyle new (STDStyle style)
 Create copy of style. More...
 
void setAlignment (int alignment)
 Set alignment. More...
 
void setBackgroundColor (Color color)
 Set background color. More...
 
void setCharacterSpacing (int spacing)
 Set spacing between characters in pixels. More...
 
void setFirstLineIndent (int indent)
 Set indention of the first line in pixels. More...
 
void setFont (Font font)
 Set font. More...
 
void setLineSpacing (int spacing)
 Set spacing between lines in pixels. More...
 
void setMargins (RectArea margins)
 Set margins in pixels. More...
 
void setTextColor (Color color)
 Set text color. More...
 

Detailed Description

Styled text definition style.

Defines a style for nodes in a styled text definition. The left and right margins are relative to the left and right page margins of the parent styled text definition object. The top margin is relative to the previous node lower position augmented by the previous node bottom margin. Hence the starting position of a node is the lower boundary of the previous node plus a gap equal to the sum of the previous nodes style bottom margin and this styles top margin.

Member Function Documentation

§ getAlignment()

int getAlignment ( )

Alignment.

§ getBackgroundColor()

Color getBackgroundColor ( )

Background color.

§ getCharacterSpacing()

int getCharacterSpacing ( )

Spacing between characters in pixels.

§ getFirstLineIndent()

int getFirstLineIndent ( )

Indention of the first line in pixels.

§ getFont()

Font getFont ( )

Font.

§ getLineSpacing()

int getLineSpacing ( )

Spacing between lines in pixels.

§ getMargins()

RectArea getMargins ( )

Margins in pixels.

§ getName()

String getName ( )

Name of style.

§ getTextColor()

Color getTextColor ( )

Text color.

§ new() [1/2]

STDStyle new ( String  name)

Create style.

§ new() [2/2]

STDStyle new ( STDStyle  style)

Create copy of style.

§ setAlignment()

void setAlignment ( int  alignment)

Set alignment.

§ setBackgroundColor()

void setBackgroundColor ( Color  color)

Set background color.

§ setCharacterSpacing()

void setCharacterSpacing ( int  spacing)

Set spacing between characters in pixels.

§ setFirstLineIndent()

void setFirstLineIndent ( int  indent)

Set indention of the first line in pixels.

§ setFont()

void setFont ( Font  font)

Set font.

§ setLineSpacing()

void setLineSpacing ( int  spacing)

Set spacing between lines in pixels.

§ setMargins()

void setMargins ( RectArea  margins)

Set margins in pixels.

§ setTextColor()

void setTextColor ( Color  color)

Set text color.


The documentation for this class was generated from the following file: