Package org.eclipse.jface.text.source

Class SourceViewer.RulerLayout

java.lang.Object

org.eclipse.swt.widgets.Layout

org.eclipse.jface.text.source.SourceViewer.RulerLayout

Enclosing class:

SourceViewer

protected class SourceViewer.RulerLayout
extends Layout

Layout of a source viewer. Vertical ruler, text widget, and overview ruler are shown side by side.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	fGap	The gap between the text viewer and the vertical ruler.

Constructor Summary

Constructors

Constructor	Description
RulerLayout(int gap)	Creates a new ruler layout with the given gap between text viewer and vertical ruler.

Method Summary

Modifier and Type	Method	Description
protected Point	computeSize(Composite composite, int wHint, int hHint, boolean flushCache)	Computes and returns the size of the specified composite's client area according to this layout.
protected void	layout(Composite composite, boolean flushCache)	Lays out the children of the specified composite according to this layout.

Methods inherited from class org.eclipse.swt.widgets.Layout

flushCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

fGap

protected int fGap

The gap between the text viewer and the vertical ruler.

Constructor Details

RulerLayout

public RulerLayout(int gap)

Creates a new ruler layout with the given gap between text viewer and vertical ruler.

Parameters:

gap - the gap between text viewer and vertical ruler

Method Details

computeSize

protected Point computeSize(Composite composite,
 int wHint,
 int hHint,
 boolean flushCache)

Description copied from class: Layout

Computes and returns the size of the specified composite's client area according to this layout.

This method computes the size that the client area of the composite must be in order to position all children at their preferred size inside the composite according to the layout algorithm encoded by this layout.

When a width or height hint is supplied, it is used to constrain the result. For example, if a width hint is provided that is less than the width of the client area, the layout may choose to wrap and increase height, clip, overlap, or otherwise constrain the children.

Specified by:

computeSize in class Layout

Parameters:

composite - a composite widget using this layout

wHint - width (SWT.DEFAULT for preferred size)

hHint - height (SWT.DEFAULT for preferred size)

flushCache - true means flush cached layout values

Returns:

a point containing the computed size (width, height)

See Also:

• Layout.layout(org.eclipse.swt.widgets.Composite, boolean)
• Control.getBorderWidth()
• Control.getBounds()
• Control.getSize()
• Control.pack(boolean)
• "computeTrim, getClientArea for controls that implement them"

layout

protected void layout(Composite composite,
 boolean flushCache)

Description copied from class: Layout

Lays out the children of the specified composite according to this layout.

This method positions and sizes the children of a composite using the layout algorithm encoded by this layout. Children of the composite are positioned in the client area of the composite. The position of the composite is not altered by this method.

When the flush cache hint is true, the layout is instructed to flush any cached values associated with the children. Typically, a layout will cache the preferred sizes of the children to avoid the expense of computing these values each time the widget is laid out.

When layout is triggered explicitly by the programmer the flush cache hint is true. When layout is triggered by a resize, either caused by the programmer or by the user, the hint is false.

Specified by:

layout in class Layout

Parameters:

composite - a composite widget using this layout

flushCache - true means flush cached layout values