org.autoplot.dom

Class Canvas

java.lang.Object

org.autoplot.dom.DomNode

org.autoplot.dom.Canvas

All Implemented Interfaces:

java.lang.Cloneable

public class Canvas
extends DomNode

The state of the canvas which is the area on which plots are drawn.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Column>	columns
protected CanvasController	controller
protected boolean	fitted
protected java.lang.String	font
protected int	height
protected Column	marginColumn
protected Row	marginRow
static java.lang.String	PROP_COLUMNS
static java.lang.String	PROP_FITTED boolean property indicates that the canvas is resizable.
static java.lang.String	PROP_FONT
static java.lang.String	PROP_HEIGHT
static java.lang.String	PROP_MARGINCOLUMN
static java.lang.String	PROP_MARGINROW
static java.lang.String	PROP_ROWS
static java.lang.String	PROP_WIDTH
protected java.util.List<Row>	rows
protected int	width

Fields inherited from class org.autoplot.dom.DomNode

id, logger, PROP_ID, propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
Canvas()

Method Summary

Modifier and Type	Method and Description
java.util.List<DomNode>	childNodes() return any child nodes.
DomNode	copy() returns a deep copy of the node.
java.util.List<Diff>	diffs(DomNode node) return a list of the differences between this and another node.
Column[]	getColumns()
Column	getColumns(int index)
CanvasController	getController()
java.lang.String	getFont()
int	getHeight()
Column	getMarginColumn()
Row	getMarginRow()
Row[]	getRows()
Row	getRows(int index)
int	getWidth()
boolean	isFitted()
void	setColumns(Column[] columns)
void	setColumns(int index, Column newColumns)
void	setFitted(boolean fitted)
void	setFont(java.lang.String font)
void	setHeight(int height) set height before firing off changes
void	setMarginColumn(Column marginColumn)
void	setMarginRow(Row marginRow)
void	setRows(int index, Row newRows)
void	setRows(Row[] rows)
void	setSize(int width, int height) set both the width and height before firing off changes.
void	setWidth(int width) set width before firing off changes
void	syncTo(DomNode n) bulk assignment of properties.
void	syncTo(DomNode n, java.util.List<java.lang.String> exclude) Bulk assignment of properties, but allow specification of properties to exclude.

Methods inherited from class org.autoplot.dom.DomNode

addPropertyChangeListener, addPropertyChangeListener, boundCount, getId, removePropertyChangeListener, removePropertyChangeListener, setId, toString

Methods inherited from class java.lang.Object

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

Field Detail

controller

protected CanvasController controller

height

protected int height

PROP_HEIGHT

public static final java.lang.String PROP_HEIGHT

See Also:

Constant Field Values

width

protected int width

PROP_WIDTH

public static final java.lang.String PROP_WIDTH

See Also:

Constant Field Values

fitted

protected boolean fitted

PROP_FITTED

public static final java.lang.String PROP_FITTED

boolean property indicates that the canvas is resizable.

See Also:

Constant Field Values

font

protected java.lang.String font

PROP_FONT

public static final java.lang.String PROP_FONT

See Also:

Constant Field Values

PROP_ROWS

public static final java.lang.String PROP_ROWS

See Also:

Constant Field Values

rows

protected java.util.List<Row> rows

PROP_COLUMNS

public static final java.lang.String PROP_COLUMNS

See Also:

Constant Field Values

columns

protected java.util.List<Column> columns

marginRow

protected Row marginRow

PROP_MARGINROW

public static final java.lang.String PROP_MARGINROW

See Also:

Constant Field Values

marginColumn

protected Column marginColumn

PROP_MARGINCOLUMN

public static final java.lang.String PROP_MARGINCOLUMN

See Also:

Constant Field Values

Constructor Detail

Canvas

public Canvas()

Method Detail

getHeight

public int getHeight()

setHeight

public void setHeight(int height)

set height before firing off changes

Parameters:

height -

getWidth

public int getWidth()

setWidth

public void setWidth(int width)

set width before firing off changes

Parameters:

width -

setSize

public void setSize(int width,
                    int height)

set both the width and height before firing off changes.

Parameters:

width - the canvas width in pixels.

height - the canvas height in pixels.

isFitted

public boolean isFitted()

setFitted

public void setFitted(boolean fitted)

getFont

public java.lang.String getFont()

setFont

public void setFont(java.lang.String font)

getRows

public Row[] getRows()

setRows

public void setRows(Row[] rows)

getRows

public Row getRows(int index)

setRows

public void setRows(int index,
                    Row newRows)

getColumns

public Column[] getColumns()

setColumns

public void setColumns(Column[] columns)

getColumns

public Column getColumns(int index)

setColumns

public void setColumns(int index,
                       Column newColumns)

getMarginRow

public Row getMarginRow()

setMarginRow

public void setMarginRow(Row marginRow)

getMarginColumn

public Column getMarginColumn()

setMarginColumn

public void setMarginColumn(Column marginColumn)

getController

public CanvasController getController()

childNodes

public java.util.List<DomNode> childNodes()

Description copied from class: DomNode

return any child nodes.

Overrides:

childNodes in class DomNode

Returns:

copy

public DomNode copy()

Description copied from class: DomNode

returns a deep copy of the node.

Overrides:

copy in class DomNode

Returns:

syncTo

public void syncTo(DomNode n)

Description copied from class: DomNode

bulk assignment of properties. When the node's children differ, then a controller should be used to implement the sync. Syncing should include the node's ID.

Overrides:

syncTo in class DomNode

syncTo

public void syncTo(DomNode n,
                   java.util.List<java.lang.String> exclude)

Description copied from class: DomNode

Bulk assignment of properties, but allow specification of properties to exclude. Note exclude should be passed to children when this is overriden, normally to exclude id property.

Overrides:

syncTo in class DomNode

diffs

public java.util.List<Diff> diffs(DomNode node)

Description copied from class: DomNode

return a list of the differences between this and another node. The differences describe how to mutate that node to make it like this node.

Overrides:

diffs in class DomNode

Returns: