|
Eclipse Draw2d 3.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.draw2d.Figure
org.eclipse.draw2d.text.FlowFigure
org.eclipse.draw2d.text.BlockFlow
A FlowFigure
represented by a single BlockBox
containing one or
more lines. A BlockFlow is a creator of LineBoxes, which its children require during
layout. A BlockFlow can be thought of as a foundation for a paragraph.
BlockFlows must be parented by a FlowFigure
. FlowPage
can be
used as a "root" block and can be parented by normal Figures.
Only FlowFigure
s can be added to a BlockFlow.
WARNING: This class is not intended to be subclassed by clients.
Nested Class Summary |
Nested classes inherited from class org.eclipse.draw2d.Figure |
Figure.FigureIterator, Figure.IdentitySearch |
Nested classes inherited from class org.eclipse.draw2d.IFigure |
IFigure.NoInsets |
Field Summary |
Fields inherited from class org.eclipse.draw2d.text.FlowFigure |
selectionStart |
Fields inherited from class org.eclipse.draw2d.Figure |
bgColor, border, bounds, fgColor, flags, font, MAX_FLAG, maxSize, minSize, NO_MANAGER, prefSize, toolTip |
Fields inherited from interface org.eclipse.draw2d.IFigure |
MAX_DIMENSION, MIN_DIMENSION, NO_INSETS |
Constructor Summary | |
BlockFlow()
Constructs a new BlockFlow. |
Method Summary | |
protected void |
contributeBidi(BidiProcessor proc)
BlockFlows contribute a paragraph separator so as to keep the Bidi state of the text on either side of this block from affecting each other. |
protected FlowFigureLayout |
createDefaultFlowLayout()
Creates the default layout manager |
protected BlockBox |
getBlockBox()
Returns the BlockBox associated with this. |
int |
getHorizontalAligment()
Returns the effective horizontal alignment. |
int |
getLocalHorizontalAlignment()
Returns the horizontal alignment set on this block. |
int |
getLocalOrientation()
Returns the orientation set on this block. |
int |
getOrientation()
Returns this block's Bidi orientation. |
void |
paintBorder(Graphics graphics)
Paints the border associated with this Figure, if one exists. |
void |
postValidate()
Called after validate has occurred. |
void |
revalidate()
Invalidates this figure and revalidates() its parent. |
protected void |
revalidateBidi(IFigure origin)
A Block will invalidate the Bidi state of all its children, so that it is re-evaluated when this block is next validated. |
void |
setHorizontalAligment(int value)
Sets the horitontal aligment of the block. |
void |
setOrientation(int orientation)
Sets the orientation for this block. |
protected boolean |
useLocalCoordinates()
Returns true if this Figure uses local coordinates. |
void |
validate()
Re-evaluate the Bidi state of all the fragments if it has been invalidated. |
Methods inherited from class org.eclipse.draw2d.text.FlowFigure |
add, addLeadingWordRequirements, remove, setBidiInfo, setBounds, setFlowContext, setSelection |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BlockFlow()
Method Detail |
protected void contributeBidi(BidiProcessor proc)
contributeBidi
in class FlowFigure
proc
- the BidiProcessor to which contributions should be madeFlowFigure.contributeBidi(org.eclipse.draw2d.text.BidiProcessor)
protected FlowFigureLayout createDefaultFlowLayout()
FlowFigure
createDefaultFlowLayout
in class FlowFigure
FlowFigure.createDefaultFlowLayout()
protected BlockBox getBlockBox()
public int getHorizontalAligment()
PositionConstants.NONE
. If the value is none, it will return the inherited alignment.
If no alignment was inherited, it will return the default alignment (PositionConstants.LEFT
).
public int getLocalOrientation()
setOrientation(int)
public int getLocalHorizontalAlignment()
setHorizontalAligment(int)
public int getOrientation()
setOrientation(int)
public void paintBorder(Graphics graphics)
Figure
paintBorder
in class Figure
graphics
- The Graphics used to paintFigure.paintBorder(org.eclipse.draw2d.Graphics)
public void postValidate()
FlowFigure
postValidate
in class FlowFigure
FlowFigure.postValidate()
public void revalidate()
IFigure
revalidate
in interface IFigure
revalidate
in class Figure
Figure.revalidate()
protected void revalidateBidi(IFigure origin)
revalidateBidi
in class FlowFigure
origin
- the figure that was revalidatedFlowFigure.revalidateBidi(org.eclipse.draw2d.IFigure)
public void setHorizontalAligment(int value)
NONE
- (default) Alignment is inherited from
parent. If a parent is not found then LEFT is used.PositionConstants.LEFT
- Alignment is with leading edgePositionConstants.RIGHT
- Alignment is with trailing edgePositionConstants.CENTER
PositionConstants.ALWAYS_LEFT
- Left, irrespective of orientationPositionConstants.ALWAYS_RIGHT
- Right, irrespective of orientation
value
- the aligmentgetHorizontalAligment()
public void setOrientation(int orientation)
SWT.LEFT_TO_RIGHT
SWT.RIGHT_TO_LEFT
SWT.NONE
(default)
NONE
is used to indicate that orientation should be inherited from the
encompassing block.
orientation
- LTR, RTL or NONEgetOrientation()
protected boolean useLocalCoordinates()
Figure
true
if this Figure uses local coordinates. This means its
children are placed relative to this Figure's top-left corner.
useLocalCoordinates
in class Figure
true
if this Figure uses local coordinatesFigure.useLocalCoordinates()
public void validate()
validate
in interface IFigure
validate
in class Figure
IFigure.validate()
|
Eclipse Draw2d 3.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |