Package org.eclipse.draw2d.text
Class InlineFlowLayout
java.lang.Object
org.eclipse.draw2d.text.FlowFigureLayout
org.eclipse.draw2d.text.FlowContainerLayout
org.eclipse.draw2d.text.InlineFlowLayout
- All Implemented Interfaces:
LayoutManager
,FlowContext
The layout manager for
InlineFlow
figures.
WARNING: This class is not intended to be subclassed by clients.
- Since:
- 2.1
-
Constructor Summary
ConstructorsConstructorDescriptionInlineFlowLayout
(FlowFigure flow) Creates a new InlineFlowLayout with the given FlowFigure. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addLine
(CompositeBox box) Adds the given box as a line below the current line.protected void
Used by getCurrentLine().void
endLine()
The current line should be committed if it is occupied, and then set tonull
.protected void
flush()
Called afterFlowContainerLayout.layoutChildren()
when all children have been laid out.boolean
InlineFlowLayout gets this information from its context.protected InlineFlow
void
getWidthLookahead
(FlowFigure child, int[] result) This method looks ahead for line-breaks.boolean
void
Clears out all fragments prior to the call to layoutChildren().void
setContinueOnSameLine
(boolean value) InlineFlow passes this information to its context.protected void
Initializes the given LineBox.Methods inherited from class org.eclipse.draw2d.text.FlowContainerLayout
addToCurrentLine, cleanup, getRemainingLineWidth, layout, layoutChildren
Methods inherited from class org.eclipse.draw2d.text.FlowFigureLayout
getConstraint, getContext, getMinimumSize, getPreferredSize, invalidate, layout, remove, setConstraint, setFlowContext
-
Constructor Details
-
InlineFlowLayout
Creates a new InlineFlowLayout with the given FlowFigure.- Parameters:
flow
- The FlowFigure
-
-
Method Details
-
addLine
Adds the given box as a line below the current line.- Parameters:
box
- the box to add
-
createNewLine
protected void createNewLine()Description copied from class:FlowContainerLayout
Used by getCurrentLine().- Specified by:
createNewLine
in classFlowContainerLayout
- See Also:
-
endLine
public void endLine()Description copied from interface:FlowContext
The current line should be committed if it is occupied, and then set tonull
. Otherwise, do nothing.- See Also:
-
getFlowFigure
- Overrides:
getFlowFigure
in classFlowFigureLayout
- Returns:
- the FlowFigure
- Since:
- 3.15
-
flush
protected void flush()Description copied from class:FlowContainerLayout
Called afterFlowContainerLayout.layoutChildren()
when all children have been laid out. This method exists to flush the last line.- Specified by:
flush
in classFlowContainerLayout
- See Also:
-
getContinueOnSameLine
public boolean getContinueOnSameLine()InlineFlowLayout gets this information from its context.- Returns:
true
if the next fragment should be placed on the current line- See Also:
-
getWidthLookahead
Description copied from interface:FlowContext
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 childresult
- 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- See Also:
-
isCurrentLineOccupied
public boolean isCurrentLineOccupied()- Specified by:
isCurrentLineOccupied
in interfaceFlowContext
- Overrides:
isCurrentLineOccupied
in classFlowContainerLayout
- Returns:
true
if the current line contains any fragments- See Also:
-
preLayout
public void preLayout()Clears out all fragments prior to the call to layoutChildren().- Specified by:
preLayout
in classFlowContainerLayout
-
setContinueOnSameLine
public void setContinueOnSameLine(boolean value) InlineFlow passes this information to its context.- 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- See Also:
-
setupLine
Initializes the given LineBox. Called by createNewLine().- Parameters:
line
- The LineBox to initialize.
-