net.mumie.mathletfactory.display.noc.op.node

Class ViewNode

java.lang.Object

net.mumie.mathletfactory.display.noc.op.node.ViewNode

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AbsView, AddView, ConjView, ExpView, FacView, FunctionView, MultView, NrtView, NumberView, PowerView, VariableView

public abstract class ViewNode
extends java.lang.Object
implements java.lang.Cloneable

This class serves as a base class for all operation view nodes. Operation view nodes represent the graphical view of an algebraic Operation Node and are also organized as nodes forming a tree.

Author:

Paehler

Document status:

finished

Field Summary

Fields

Modifier and Type	Field and Description
protected ViewNode[]	m_children The child nodes of this view node.
protected java.text.DecimalFormat	m_format
protected OpNode	m_master The master node, the model of this view
protected java.awt.Graphics2D	OFFLINEGRAPHICS Used for temporary offline-rendering (e.g. determining the size of the panel)

Constructor Summary

Constructors

Constructor and Description
ViewNode()

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.awt.geom.Rectangle2D	centerHorizontally(java.awt.geom.Rectangle2D frame, double left, double right, double y) A utility method that returns a rectangle that is horizontally centered betwwen left and right and has y as upper boundary.
java.lang.Object	clone() Create a "deep copy" of the subtree rooted by this node.
ViewNodeMetrics	draw(java.awt.Graphics2D g2, double xPos, double yPos, int printFlags) Draws the expression represented by this node onto g2 using position (xPos, yPos) as lower left corner.
protected abstract ViewNodeMetrics	drawExpression(java.awt.Graphics2D g2, double xPos, double yPos, int printFlags) Draws the actual expression without parentheses, factor and exponent
protected ViewNodeMetrics	drawFactor(java.awt.Graphics2D g2, double xPos, double yPos, int printFlags) Draws the factor of the expression represented by this node.
protected static ViewNodeMetrics	drawParenShape(java.awt.Graphics2D g2, double xPos, double yPos, java.lang.String glyph, ViewNodeMetrics expressionMetrics) Draws the parenthesis specified by glyph onto g2, using (xPos,yPos) as lower left corner.
protected static java.awt.geom.Rectangle2D	drawText(java.awt.Graphics2D g2, double xPos, double yPos, java.lang.String text) Draws text onto g2 beginning using position (xPos, yPos) as lower left corner.
double	getBaseline() Returns the baseline for the expression represented by this node.
java.awt.geom.Rectangle2D	getBounds() Returns the overall bounds of the expression represented by this node.
java.text.DecimalFormat	getDecimalFormat() Returns the display format for decimal (i.e.
protected OpNode	getMaster() Return the net.mumie.mathletfactory.algebra.op.node.OpNode, that is the model for this view node.
ViewNodeMetrics	getMetrics() Returns the bounds covering the rendered text of this node
protected static double	getSpacer(java.awt.Graphics2D g2) this method is used for creating a small "dotwide" space depending on the current font.
void	setChildren(ViewNode[] children) Inserts the argument as children for this node.
void	setDecimalFormat(java.text.DecimalFormat format) Sets the given display format for decimal (i.e.
void	setMaster(OpNode node) Sets the OpNode that this node is the view for.
java.lang.String	toString() Returns {@link net.mumie.mathletfactory.algebra.op.node.OpNode#toString master.toString()}.

Methods inherited from class java.lang.Object

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

Field Detail

m_master

protected OpNode m_master

The master node, the model of this view

m_children

protected ViewNode[] m_children

The child nodes of this view node.

m_format

protected java.text.DecimalFormat m_format

OFFLINEGRAPHICS

protected final java.awt.Graphics2D OFFLINEGRAPHICS

Used for temporary offline-rendering (e.g. determining the size of the panel)

Constructor Detail

ViewNode

public ViewNode()

Method Detail

getMetrics

public ViewNodeMetrics getMetrics()

Returns the bounds covering the rendered text of this node

setMaster

public void setMaster(OpNode node)

Sets the OpNode that this node is the view for.

setChildren

public void setChildren(ViewNode[] children)

Inserts the argument as children for this node.

drawExpression

protected abstract ViewNodeMetrics drawExpression(java.awt.Graphics2D g2,
                             double xPos,
                             double yPos,
                             int printFlags)

Draws the actual expression without parentheses, factor and exponent

drawFactor

protected ViewNodeMetrics drawFactor(java.awt.Graphics2D g2,
                         double xPos,
                         double yPos,
                         int printFlags)

Draws the factor of the expression represented by this node. This method is called from draw(java.awt.Graphics2D, double, double, int) before the actual expression is drawn.

draw

public ViewNodeMetrics draw(java.awt.Graphics2D g2,
                   double xPos,
                   double yPos,
                   int printFlags)

Draws the expression represented by this node onto g2 using position (xPos, yPos) as lower left corner.

Returns:

ViewNodeMetrics the metrics of the drawn expression.

drawParenShape

protected static ViewNodeMetrics drawParenShape(java.awt.Graphics2D g2,
                             double xPos,
                             double yPos,
                             java.lang.String glyph,
                             ViewNodeMetrics expressionMetrics)

Draws the parenthesis specified by glyph onto g2, using (xPos,yPos) as lower left corner. expressionMetrics is used for the height of the parenthesis.

Returns:

ViewNodeMetrics the metrics of the drawn parenthesis

getMaster

protected OpNode getMaster()

Return the net.mumie.mathletfactory.algebra.op.node.OpNode, that is the model for this view node.

getBaseline

public double getBaseline()

Returns the baseline for the expression represented by this node.

getBounds

public java.awt.geom.Rectangle2D getBounds()

Returns the overall bounds of the expression represented by this node.

drawText

protected static java.awt.geom.Rectangle2D drawText(java.awt.Graphics2D g2,
                                 double xPos,
                                 double yPos,
                                 java.lang.String text)

Draws text onto g2 beginning using position (xPos, yPos) as lower left corner.

Returns:

Rectangle2D the bounds of the drawn text.

centerHorizontally

protected static java.awt.geom.Rectangle2D centerHorizontally(java.awt.geom.Rectangle2D frame,
                                           double left,
                                           double right,
                                           double y)

A utility method that returns a rectangle that is horizontally centered betwwen left and right and has y as upper boundary.

clone

public java.lang.Object clone()

Create a "deep copy" of the subtree rooted by this node.

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

getSpacer

protected static double getSpacer(java.awt.Graphics2D g2)

this method is used for creating a small "dotwide" space depending on the current font.

toString

public java.lang.String toString()

Returns {@link net.mumie.mathletfactory.algebra.op.node.OpNode#toString master.toString()}.

Overrides:

toString in class java.lang.Object

setDecimalFormat

public void setDecimalFormat(java.text.DecimalFormat format)

Sets the given display format for decimal (i.e. MDouble) numbers. Otherwise the format using NumberView.DEFAULT_PATTERN is used.

getDecimalFormat

public java.text.DecimalFormat getDecimalFormat()

Returns the display format for decimal (i.e. MDouble) numbers.