Eclipse GEF and Draw2d Plug-in Developer Guide (Galileo) - FlowContext (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
Interface FlowContext

All Known Implementing Classes:: FlowContainerLayout

public interface FlowContext

The context that a FlowFigureLayout uses to perform its layout.

WARNING: This interface is not intended to be implemented by clients. It exists to define the API between the layout and its context.

Method Summary

void addLine ( CompositeBox box)
          Adds an entire line into the context.

void addToCurrentLine ( FlowBox box)
          Adds the given box into the current line.

void endLine ()
          The current line should be committed if it is occupied, and then set to null.

boolean getContinueOnSameLine ()
          This method is used to convey layout state to different FlowFigures.

int getRemainingLineWidth ()
          This method can be used to query the amount of space left on the current line.

void getWidthLookahead ( FlowFigure child, int[] width)
          This method looks ahead for line-breaks.

boolean isCurrentLineOccupied ()


void setContinueOnSameLine (boolean value)
          This method is used to convey layout state to different FlowFigures.

Method Detail

addToCurrentLine

public void addToCurrentLine(
FlowBox box)

Adds the given box into the current line.

Parameters:: box - the FlowBox to add

addLine

public void addLine(
CompositeBox box)

Adds an entire line into the context. If there is a previous line, it is ended.

Parameters:: box - the line being added
Since:: 3.1

endLine

public void endLine()

The current line should be committed if it is occupied, and then set to null. Otherwise, do nothing.

getRemainingLineWidth

public int getRemainingLineWidth()

This method can be used to query the amount of space left on the current line. It can help determine where to wrap during layout.

Returns:: the amount of space left on the current line
Since:: 3.1

getContinueOnSameLine

public boolean getContinueOnSameLine()

This method is used to convey layout state to different FlowFigures. This state is cleared when a fragment is added to the current line and once the layout is complete.

Returns:: true if the next fragment should be placed on the current line
Since:: 3.1
See Also:: setContinueOnSameLine(boolean)

getWidthLookahead

public void getWidthLookahead(
FlowFigure child,
                              int[] width)

This method looks ahead for line-breaks. When laying out, this method can be used to determine the next line-break across multiple figures.

Parameters:: child - the search will occur starting from the figure after the given child; width - the width before the next line-break (if one's found; all the width, otherwise) will be added on to the first int in the given array
Since:: 3.1

isCurrentLineOccupied

public boolean isCurrentLineOccupied()

Returns:: true if the current line contains any fragments

setContinueOnSameLine

public void setContinueOnSameLine(boolean value)

This method is used to convey layout state to different FlowFigures. This state is cleared when a fragment is added and once the layout is complete.

Parameters:: value - true indicates that the first fragment of the next TextFlow should be laid out on the current line, and not a new one
Since:: 3.1
See Also:: getContinueOnSameLine()