Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - LineRoot (Eclipse Draw2d API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Draw2d
3.3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

LineRoot is the top-most container on a line of text displayed in Draw2d. Hence, a LineRoot can tell you of things like the highest ascent or descent on a line, which is required to display selection and such. All fragments know of the LineRoot they belong to.

Since:: 3.1

Constructor Summary

LineRoot (boolean isMirrored)
          Constructor

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)
          A LineRoot cannot be targetted.

int getBaseline ()
          Returns y coordinate for the box's baseline.

void setBaseline (int baseline)
          Positions the line vertically by settings its 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)

Constructor
Parameters:: isMirrored - true if the line is to be displayed in a mirrored control

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

See Also:: CompositeBox.add(org.eclipse.draw2d.text.FlowBox)

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)

A LineRoot cannot be targetted.

Specified by:: containsPoint in class FlowBox

Parameters:: x - X; y - Y
Returns:: true if the FlowBox contains the point
See Also:: FlowBox.containsPoint(int, int)

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
See Also:: FlowBox.getBaseline()

setBaseline

public void setBaseline(int baseline)

Positions the line vertically by settings its baseline.

Parameters:: baseline - the baseline

setLineTop

public void setLineTop(int top)