|
Eclipse Draw2d 3.8.0.201206011245 |
|||||||||
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
public abstract class FlowFigure
The base implementation for text flow figures. A flow figure is used to render a document in which elements are laid out horizontally within a "line" until that line is filled. Layout continues on the next line.
WARNING: This class is not intended to be subclassed by clients. Future versions may contain additional abstract methods.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.draw2d.Figure |
---|
Figure.FigureIterator, Figure.IdentitySearch |
Nested classes/interfaces inherited from interface org.eclipse.draw2d.IFigure |
---|
IFigure.NoInsets |
Field Summary | |
---|---|
protected int |
selectionStart
integer indicating whether selection should be displayed. |
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 | |
---|---|
FlowFigure()
Constructs a new FlowFigure. |
Method Summary | |
---|---|
void |
add(IFigure child,
Object constraint,
int index)
If the child is a FlowFigure , its FlowContext is passed to
it. |
boolean |
addLeadingWordRequirements(int[] width)
Calculates the width of text before the next line-break is encountered. |
protected void |
contributeBidi(BidiProcessor proc)
FlowFigures can contribute text for their block to the given BidiProcessor , which will process the contributions to determine
Bidi levels and shaping requirements. |
protected abstract FlowFigureLayout |
createDefaultFlowLayout()
Creates the default layout manager |
abstract void |
postValidate()
Called after validate has occurred. |
void |
remove(IFigure figure)
Overridden to revalidateBidi when fragments are removed. |
protected void |
revalidateBidi(IFigure origin)
This method should be invoked whenever a change that can potentially affect the Bidi evaluation is made (eg., adding or removing children, changing text, etc.). |
void |
setBidiInfo(BidiInfo info)
Sets the bidi information for this figure. |
void |
setBounds(Rectangle r)
FlowFigures override setBounds() to prevent translation of children. |
void |
setFlowContext(FlowContext flowContext)
Sets the flow context. |
void |
setSelection(int start,
int end)
Sets the selection or a range of selection. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int selectionStart
Constructor Detail |
---|
public FlowFigure()
Method Detail |
---|
public void add(IFigure child, Object constraint, int index)
FlowFigure
, its FlowContext is passed to
it.
add
in interface IFigure
add
in class Figure
child
- The IFigure to addconstraint
- The newly added IFigure's constraintindex
- The index where the IFigure should be addedIFigure.add(IFigure, Object, int)
public boolean addLeadingWordRequirements(int[] width)
Default implementation treats each FlowFigure as a line-break. It adds no
width and returns true
. Sub-classes should override as
needed.
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
protected void contributeBidi(BidiProcessor proc)
BidiProcessor
, which will process the contributions to determine
Bidi levels and shaping requirements.
This method is invoked as part of validating Bidi.
Sub-classes that cache the BidiInfo and/or the bidi level in ContentBoxes should clear the cached values when this method is invoked.
proc
- the BidiProcessor to which contributions should be madeBidiProcessor.add(FlowFigure, String)
protected abstract FlowFigureLayout createDefaultFlowLayout()
public abstract void postValidate()
public void remove(IFigure figure)
remove
in interface IFigure
remove
in class Figure
figure
- The Figure to removeIFigure.remove(org.eclipse.draw2d.IFigure)
protected void revalidateBidi(IFigure origin)
The default implementation delegates the revalidation task to the parent.
Only blocks
perform the actual
revalidation.
The given IFigure is the one that triggered the revalidation. This can be used to optimize bidi evaluation.
origin
- the figure that was revalidatedpublic void setBidiInfo(BidiInfo info)
contributeBidi(BidiProcessor)
. If the figure contributes
text associated with it, this method is called back to indicate the bidi
properties for that text within its block.
info
- the BidiInfo for this figurepublic void setBounds(Rectangle r)
setBounds
in interface IFigure
setBounds
in class Figure
r
- The new boundsFigure.setBounds(Rectangle)
public void setFlowContext(FlowContext flowContext)
flowContext
- the flow context for this flow figurepublic void setSelection(int start, int end)
start
- the start offsetend
- the end offset
|
Eclipse Draw2d 3.8.0.201206011245 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |