org.ginsim.common.document

Class DocumentStyle

java.lang.Object

org.ginsim.common.document.DocumentStyle

public class DocumentStyle
extends Object

DocumentStyle contain a generic representation of the style for a document
A DocumentStyle is a map of styles identified by their name (like the class in HTML), followed by a map of couples (property, value) and the function to manipulate them.

DocumentStyle contains a set of constants representing the minimal set of styles a DocumentWriter should support.

Author:

Aurelien Naldi, Duncan Berenguier

See Also:

DocumentWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLOR
static String	FONT_SIZE
static String	HEIGHT
static String	LIST_TYPE
static String	TABLE_BORDER
static String	WIDTH

Constructor Summary

Constructors

Constructor and Description
DocumentStyle()

Method Summary

Modifier and Type	Method and Description
void	addProperties(Object[] properties) Add all the properties to the style
void	addProperty(String property, Object value) Add a property with a value to the current style
void	addProperty(String style, String property, Object value) Add a property with a value to the style
void	addStyle(String value) Create a new style identified by value. The current style is set to it.
String	getCurrentStyle() Return the current style
Map	getPropertiesForStyle(String style) Return all the properties for a style
Iterator<String>	getPropertiesIteratorForStyle(String style) Return an iterator over the properties for a style
Iterator<String>	getStyleIterator() Return an iterator over the styles identifiers.

Methods inherited from class java.lang.Object

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

Field Detail

LIST_TYPE

public static final String LIST_TYPE

See Also:

Constant Field Values

COLOR

public static final String COLOR

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

See Also:

Constant Field Values

FONT_SIZE

public static final String FONT_SIZE

See Also:

Constant Field Values

TABLE_BORDER

public static final String TABLE_BORDER

See Also:

Constant Field Values

Constructor Detail

DocumentStyle

public DocumentStyle()

Method Detail

addStyle

public void addStyle(String value)

Create a new style identified by value.
The current style is set to it.

Parameters:

value - the style's class (HTML sense)

addProperty

public void addProperty(String property,
                        Object value)

Add a property with a value to the current style

Parameters:

property -

value -

addProperty

public void addProperty(String style,
                        String property,
                        Object value)

Add a property with a value to the style

Parameters:

style -

property -

value -

addProperties

public void addProperties(Object[] properties)
                   throws ArrayIndexOutOfBoundsException

Add all the properties to the style

Parameters:

properties - the array, must looks like [property, value, property, value, ...]

Throws:

ArrayIndexOutOfBoundsException

getCurrentStyle

public String getCurrentStyle()

Return the current style

Returns:

the current style

getStyleIterator

public Iterator<String> getStyleIterator()

Return an iterator over the styles identifiers.

Returns:

an iterator over the styles identifiers.

getPropertiesForStyle

public Map getPropertiesForStyle(String style)

Return all the properties for a style

Parameters:

style - the style's identifier

Returns:

the properties

getPropertiesIteratorForStyle

public Iterator<String> getPropertiesIteratorForStyle(String style)

Return an iterator over the properties for a style

Parameters:

style - the style's identifier

Returns:

an iterator over the properties