org.fit.layout.tools.io

Class HTMLOutputOperator

java.lang.Object

org.fit.layout.impl.BaseParametrizedOperation

org.fit.layout.impl.BaseOperator

org.fit.layout.tools.io.HTMLOutputOperator

All Implemented Interfaces:

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

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

This operator serializes the area tree to an HTML file.

Author:

burgetr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	HTMLOutputOperator.Style Element style representation.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	boxTreeOnly Should we produce the box tree only or should we rely on the area tree?
protected String	filename Path to the output file/
protected boolean	produceHeader Should we produce the HTML header and footer?
protected static String	UNIT Default length unit

Constructor Summary

Constructors

Constructor and Description
HTMLOutputOperator()
HTMLOutputOperator(String filename, boolean produceHeader, boolean boxTreeOnly)

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
List<org.fit.layout.api.Parameter>	defineParams()
void	dumpTo(org.fit.layout.model.AreaTree tree, PrintWriter out) Formats the complete area tree to an output stream.
void	dumpTo(org.fit.layout.model.Page page, PrintWriter out) Formats the complete box tree to an output stream.
protected String	getAreaStyle(org.fit.layout.model.Area a)
protected HTMLOutputOperator.Style	getBoxStyle(org.fit.layout.model.Box box, int px, int py)
protected HTMLOutputOperator.Style	getBoxStyle(org.fit.layout.model.ContentRect parent, org.fit.layout.model.Box box)
boolean	getBoxTreeOnly()
String	getCategory()
String	getDescription()
String	getFilename()
String	getId()
String	getName()
boolean	getProduceHeader()
void	setBoxTreeOnly(boolean boxTreeOnly)
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, getParams, 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, getParams, setParam

Field Detail

UNIT

protected static final String UNIT

Default length unit

See Also:

Constant Field Values

produceHeader

protected boolean produceHeader

Should we produce the HTML header and footer?

boxTreeOnly

protected boolean boxTreeOnly

Should we produce the box tree only or should we rely on the area tree?

filename

protected String filename

Path to the output file/

Constructor Detail

HTMLOutputOperator

public HTMLOutputOperator()

HTMLOutputOperator

public HTMLOutputOperator(String filename,
                          boolean produceHeader,
                          boolean boxTreeOnly)

Method Detail

getId

public String getId()

getName

public String getName()

getDescription

public String getDescription()

getCategory

public String getCategory()

defineParams

public List<org.fit.layout.api.Parameter> defineParams()

Overrides:

defineParams in class org.fit.layout.impl.BaseParametrizedOperation

getProduceHeader

public boolean getProduceHeader()

setProduceHeader

public void setProduceHeader(boolean produceHeader)

getBoxTreeOnly

public boolean getBoxTreeOnly()

setBoxTreeOnly

public void setBoxTreeOnly(boolean boxTreeOnly)

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 area tree to an output stream.

Parameters:

tree - the area tree to be printed

out - a writer to be used for output

dumpTo

public void dumpTo(org.fit.layout.model.Page page,
                   PrintWriter out)

Formats the complete box tree to an output stream.

Parameters:

tree - the area tree to be printed

out - a writer to be used for output

getAreaStyle

protected String getAreaStyle(org.fit.layout.model.Area a)

getBoxStyle

protected HTMLOutputOperator.Style getBoxStyle(org.fit.layout.model.ContentRect parent,
                                               org.fit.layout.model.Box box)

getBoxStyle

protected HTMLOutputOperator.Style getBoxStyle(org.fit.layout.model.Box box,
                                               int px,
                                               int py)

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