org.fit.layout.tools.io

Class XMLOutputOperator

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseOperator

org.fit.layout.tools.io.XMLOutputOperator

All Implemented Interfaces:

org.fit.layout.api.AreaTreeOperator, org.fit.layout.api.ParametrizedOperation, org.fit.layout.api.Service

public class XMLOutputOperator
extends org.fit.layout.impl.BaseOperator

This operator serializes the area tree to an XML file.

Author:

burgetr

Nested Class Summary

Nested classes/interfaces inherited from interface org.fit.layout.api.ParametrizedOperation

org.fit.layout.api.ParametrizedOperation.ValueType

Field Summary

Fields

Modifier and Type	Field and Description
protected String	filename Path to the output file/
protected String[]	paramNames
protected org.fit.layout.api.ParametrizedOperation.ValueType[]	paramTypes
protected boolean	produceHeader Should we produce the XML header?

Constructor Summary

Constructors

Constructor and Description
XMLOutputOperator()
XMLOutputOperator(String filename, boolean produceHeader)

Method Summary

Modifier and Type	Method and Description
void	apply(org.fit.layout.model.AreaTree atree)
void	apply(org.fit.layout.model.AreaTree atree, org.fit.layout.model.Area root)
String	colorString(String spec) Converts the CSS specification rgb(r,g,b) to #rrggbb
void	dumpTo(org.fit.layout.model.AreaTree tree, PrintWriter out) Formats the complete tag tree to an output stream
String	getDescription()
String	getFilename()
String	getId()
String	getName()
String[]	getParamNames()
org.fit.layout.api.ParametrizedOperation.ValueType[]	getParamTypes()
boolean	getProduceHeader()
void	setFilename(String filename)
void	setProduceHeader(boolean produceHeader)

Methods inherited from class org.fit.layout.impl.BaseOperator

toString

Methods inherited from class org.fit.layout.impl.BaseParametrizedOperation

getParam, getParamRange, setParam

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, getParamRange, setParam

Field Detail

produceHeader

protected boolean produceHeader

Should we produce the XML header?

filename

protected String filename

Path to the output file/

paramNames

protected final String[] paramNames

paramTypes

protected final org.fit.layout.api.ParametrizedOperation.ValueType[] paramTypes

Constructor Detail

XMLOutputOperator

public XMLOutputOperator()

XMLOutputOperator

public XMLOutputOperator(String filename,
                         boolean produceHeader)

Method Detail

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

getParamNames

public String[] getParamNames()

getParamTypes

public org.fit.layout.api.ParametrizedOperation.ValueType[] getParamTypes()

getProduceHeader

public boolean getProduceHeader()

setProduceHeader

public void setProduceHeader(boolean produceHeader)

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

apply

public void apply(org.fit.layout.model.AreaTree atree)

apply

public void apply(org.fit.layout.model.AreaTree atree,
                  org.fit.layout.model.Area root)

dumpTo

public void dumpTo(org.fit.layout.model.AreaTree tree,
                   PrintWriter out)

Formats the complete tag tree to an output stream

colorString

public String colorString(String spec)

Converts the CSS specification rgb(r,g,b) to #rrggbb

Parameters:

spec - the CSS color specification

Returns:

a #rrggbb string