com.spire.doc.documents
Class Style

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.documents.Style

All Implemented Interfaces:

IRunAttrSource, IStyle

Direct Known Subclasses:

ListStyle, ParagraphStyle

public abstract class Style
extends DocumentSerializable
implements IStyle, IRunAttrSource

Base class for paragraph and character styles.

Constructor Summary

protected

Style(Document doc) Initializes a new instance of the Style class.

Method Summary

void	applyBaseStyle(BuiltinStyle bStyle) Applies the base style
void	applyBaseStyle(java.lang.String styleName) Apply base style for current style.
void	clearRunAttrs() Clears run attributes.
static Style	createBuiltinStyle(BuiltinStyle bStyle, Document doc) Creates the built-in paragraph style.
static IStyle	createBuiltinStyle(BuiltinStyle bStyle, StyleType type, Document doc) Creates the built-in style.
abstract IStyle	deepClone() Clones itself
java.lang.Object	fetchInheritedRunAttr(int key) Gets the attribute from one of the parents or from global defaults.
CharacterFormat	getCharacterFormat() Gets the character format.
BuiltinStyle	getDefaultStyleType() Built-in Word style.
java.lang.Object	getDirectRunAttr(int key) Gets the attribute specified directly on the source or null by the key.
void	getDirectRunAttrByIndex(int index, int[] key, java.lang.Object[] value) Gets the attribute specified directly on the source by the index.
int	getDirectRunAttrsCount() Count of attribute records in direct formatting.
java.lang.String	getName() Returns or setsstyle name.
java.lang.String	getStyleId() Gets the style id.
abstract StyleType	getStyleType() Gets the type of the style.
boolean	isCustomStyle() Gets a value indicating whether this instance is custom style.
void	isCustomStyle(boolean value) Sets a value indicating whether this instance is custom style.
static BuiltinStyle	nameToBuiltIn(java.lang.String styleName) Converts string style names to BuiltinStyle.
void	setName(java.lang.String value) Sets the style name.
void	setRunAttr(int key, java.lang.Object value) Sets run attribute.

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

Style

protected Style(Document doc)

Initializes a new instance of the Style class.

Parameters:

doc - The doc.

Method Detail

getCharacterFormat

public CharacterFormat getCharacterFormat()

Gets the character format.

Returns:

The character format.

getName

public java.lang.String getName()

Returns or setsstyle name.

Specified by:

getName in interface IStyle

Returns:

String

setName

public void setName(java.lang.String value)

Description copied from interface: IStyle

Sets the style name.

Specified by:

setName in interface IStyle

Parameters:

value - String

getStyleId

public java.lang.String getStyleId()

Gets the style id.

Specified by:

getStyleId in interface IStyle

Returns:

String

getStyleType

public abstract StyleType getStyleType()

Gets the type of the style.

Specified by:

getStyleType in interface IStyle

Returns:

The type of the style.

getDefaultStyleType

public BuiltinStyle getDefaultStyleType()

Built-in Word style.

Returns:

The built in style identifier

isCustomStyle

public boolean isCustomStyle()

Gets a value indicating whether this instance is custom style.

Returns:

boolean

isCustomStyle

public void isCustomStyle(boolean value)

Sets a value indicating whether this instance is custom style.

Parameters:

value - if this instance is custom, set to true

applyBaseStyle

public void applyBaseStyle(java.lang.String styleName)

Apply base style for current style.

Parameters:

styleName - styleName

applyBaseStyle

public void applyBaseStyle(BuiltinStyle bStyle)

Applies the base style

Parameters:

bStyle - The built-in style.

deepClone

public abstract IStyle deepClone()

Clones itself

Specified by:

deepClone in interface IStyle

Returns:

IStyle

createBuiltinStyle

public static Style createBuiltinStyle(BuiltinStyle bStyle,
                                       Document doc)

Creates the built-in paragraph style.

Parameters:

bStyle - The built in style

doc - The document.

Returns:

Style

createBuiltinStyle

public static IStyle createBuiltinStyle(BuiltinStyle bStyle,
                                        StyleType type,
                                        Document doc)

Creates the built-in style.

Parameters:

bStyle - The built-in style

type - The type

doc - The document

Returns:

IStyle

nameToBuiltIn

public static BuiltinStyle nameToBuiltIn(java.lang.String styleName)

Converts string style names to BuiltinStyle.

Parameters:

styleName - Name of the style.

Returns:

BuiltinStyle

getDirectRunAttr

public java.lang.Object getDirectRunAttr(int key)

Description copied from interface: IRunAttrSource

Gets the attribute specified directly on the source or null by the key.

Specified by:

getDirectRunAttr in interface IRunAttrSource

Parameters:

key - key

Returns:

object

getDirectRunAttrsCount

public int getDirectRunAttrsCount()

Description copied from interface: IRunAttrSource

Count of attribute records in direct formatting.

Specified by:

getDirectRunAttrsCount in interface IRunAttrSource

Returns:

int

getDirectRunAttrByIndex

public void getDirectRunAttrByIndex(int index,
                                    int[] key,
                                    java.lang.Object[] value)

Description copied from interface: IRunAttrSource

Gets the attribute specified directly on the source by the index. Index should be in range [0 .. DirectRunAttrsCount - 1]

Specified by:

getDirectRunAttrByIndex in interface IRunAttrSource

Parameters:

index - int

key - leys

value - objects

fetchInheritedRunAttr

public java.lang.Object fetchInheritedRunAttr(int key)

Description copied from interface: IRunAttrSource

Gets the attribute from one of the parents or from global defaults. Throws if the attribute is not defined anywhere. If the attribute needs resolution, it is returned resolved.

Specified by:

fetchInheritedRunAttr in interface IRunAttrSource

Parameters:

key - key

Returns:

object

setRunAttr

public void setRunAttr(int key,
                       java.lang.Object value)

Description copied from interface: IRunAttrSource

Sets run attribute.

Specified by:

setRunAttr in interface IRunAttrSource

Parameters:

key - key

value - object

clearRunAttrs

public void clearRunAttrs()

Description copied from interface: IRunAttrSource

Clears run attributes.

Specified by:

clearRunAttrs in interface IRunAttrSource