org.eclipse.draw2d.text
Class LineRoot

java.lang.Object
  org.eclipse.draw2d.text.FlowBox
      org.eclipse.draw2d.text.CompositeBox
          org.eclipse.draw2d.text.LineBox
              org.eclipse.draw2d.text.LineRoot

public class LineRoot

extends LineBox

Since:

3.1

Constructor Summary

LineRoot(boolean isMirrored)

Method Summary

void	add(FlowBox child) Adds the given box and updates properties of this composite box.
void	commit() Committing a LineRoot will position its children correctly.
boolean	containsPoint(int x, int y) This method must be called on a block that is completely positioned and committed.
int	getBaseline() Returns y coordinate for the box's baseline.
void	setBaseline(int baseline)
void	setLineTop(int top) Positions the box vertically by setting the y coordinate for the top of the content of the line.

Methods inherited from class org.eclipse.draw2d.text.LineBox

getAscent, getDescent, isOccupied, requiresBidi

Methods inherited from class org.eclipse.draw2d.text.CompositeBox

getRecommendedWidth, setRecommendedWidth

Methods inherited from class org.eclipse.draw2d.text.FlowBox

getWidth, getX, setWidth, setX

Methods inherited from class java.lang.Object

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

Constructor Detail

LineRoot

public LineRoot(boolean isMirrored)

Method Detail

add

public void add(FlowBox child)

Description copied from class: CompositeBox

Adds the given box and updates properties of this composite box.

Overrides:

add in class LineBox

commit

public void commit()

Committing a LineRoot will position its children correctly. All children boxes are made to have the same baseline, and are laid out according to the Unicode BiDi Algorithm, or left-to-right if Bidi is not necessary.

containsPoint

public boolean containsPoint(int x,
                             int y)

Description copied from class: FlowBox

This method must be called on a block that is completely positioned and committed.

Specified by:

containsPoint in class FlowBox

Parameters:

x - X

y - Y

Returns:

true if the FlowBox contains the point

getBaseline

public int getBaseline()

Description copied from class: FlowBox

Returns y coordinate for the box's baseline.

Specified by:

getBaseline in class FlowBox

Returns:

the baseline location

setBaseline

public void setBaseline(int baseline)

setLineTop

public void setLineTop(int top)

Description copied from class: CompositeBox

Positions the box vertically by setting the y coordinate for the top of the content of the line. For internal use only.

Specified by:

setLineTop in class CompositeBox

Parameters:

top - the y coordinate