ag.ion.bion.officelayer.internal.text
Class CharacterProperties

java.lang.Object
  ag.ion.bion.officelayer.internal.beans.AbstractProperties
      ag.ion.bion.officelayer.internal.text.CharacterProperties

All Implemented Interfaces:

IProperties, ICharacterProperties

public class CharacterProperties
extends AbstractProperties
implements ICharacterProperties

Properties of characters.

Field Summary

Fields inherited from interface ag.ion.bion.officelayer.text.ICharacterProperties

TYPE_ID

Constructor Summary

CharacterProperties(com.sun.star.beans.XPropertySet xPropertySet)
Constructs new CharacterProperties.

Method Summary

static java.lang.String[]	getDefaultPropertyKeys() Returns the default property keys.
int	getFontColor() Returns the font color.
float	getFontSize() Returns the font size.
static IPropertyKey[]	getPossiblyPropertyKeys() Returns the possible property keys.
java.lang.String	getTypeID() Returns the id of the property.
boolean	isFontBold() Returns if the text is bold or italic or both.
boolean	isFontItalic() Returns if the text ist bold or italic or both.
boolean	isFontUnderlined() Returns if the text ist bold or italic or both.
void	setFontBold(boolean param) Sets the font of the character to bold style.
void	setFontColor(int color) Sets the font color of the caracter.
void	setFontItalic(boolean param) Sets the font of the character to italic style.
void	setFontSize(float fontSize) Sets the font size of the specific character.
void	setFontUnderline(boolean param) Sets the character to be underlined.

Methods inherited from class ag.ion.bion.officelayer.internal.beans.AbstractProperties

copyTo, getXPropertySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface ag.ion.bion.officelayer.beans.IProperties

copyTo, getXPropertySet

Constructor Detail

CharacterProperties

public CharacterProperties(com.sun.star.beans.XPropertySet xPropertySet)
                    throws java.lang.IllegalArgumentException

Constructs new CharacterProperties.

Parameters:

xPropertySet - OpenOffice.org XPropertySet interface

Throws:

java.lang.IllegalArgumentException - if the OpenOffice.org interface is not valid

Method Detail

getPossiblyPropertyKeys

public static IPropertyKey[] getPossiblyPropertyKeys()

Returns the possible property keys.

Returns:

the possible property keys

getDefaultPropertyKeys

public static java.lang.String[] getDefaultPropertyKeys()

Returns the default property keys.

Returns:

the default property keys

getTypeID

public java.lang.String getTypeID()

Returns the id of the property.

Specified by:

getTypeID in interface IProperties

Specified by:

getTypeID in class AbstractProperties

Returns:

the id of the property

getFontSize

public float getFontSize()
                  throws TextException

Returns the font size.

Specified by:

getFontSize in interface ICharacterProperties

Returns:

the font size

Throws:

TextException - if the property can not be fetched

setFontSize

public void setFontSize(float fontSize)
                 throws TextException

Sets the font size of the specific character.

Specified by:

setFontSize in interface ICharacterProperties

Parameters:

fontSize - the fontSize to be set

Throws:

TextException - if any error occurs

isFontBold

public boolean isFontBold()
                   throws TextException

Returns if the text is bold or italic or both.

Specified by:

isFontBold in interface ICharacterProperties

Returns:

true if the text ist bold

Throws:

TextException - if the property can not be fetched

setFontBold

public void setFontBold(boolean param)
                 throws TextException

Sets the font of the character to bold style.

Specified by:

setFontBold in interface ICharacterProperties

Parameters:

param - the value if to be set to bold (if true then yes)

Throws:

TextException - if any error occurs

isFontItalic

public boolean isFontItalic()
                     throws TextException

Returns if the text ist bold or italic or both.

Specified by:

isFontItalic in interface ICharacterProperties

Returns:

true the text is italic or both

Throws:

TextException - if the property can not be fetched

setFontItalic

public void setFontItalic(boolean param)
                   throws TextException

Sets the font of the character to italic style.

Specified by:

setFontItalic in interface ICharacterProperties

Parameters:

param - the value if to be set to italic (if true then yes)

Throws:

TextException - if any error occurs

isFontUnderlined

public boolean isFontUnderlined()
                         throws TextException

Returns if the text ist bold or italic or both.

Specified by:

isFontUnderlined in interface ICharacterProperties

Returns:

true the text is underlined

Throws:

TextException - if the property can not be set

setFontUnderline

public void setFontUnderline(boolean param)
                      throws TextException

Sets the character to be underlined.

Specified by:

setFontUnderline in interface ICharacterProperties

Parameters:

param - the value that indicates if the character should be underlined (if true then yes)

Throws:

TextException - if any error occurs

getFontColor

public int getFontColor()
                 throws TextException

Returns the font color.

Specified by:

getFontColor in interface ICharacterProperties

Returns:

the font color

Throws:

TextException - if the property can not be fetched

setFontColor

public void setFontColor(int color)
                  throws TextException

Sets the font color of the caracter.

Specified by:

setFontColor in interface ICharacterProperties

Parameters:

color - the font color

Throws:

TextException - if the property can not be set