| org.netbeans.editor.DrawLayer
| DrawLayer | | public interface DrawLayer (Code) | | Draw layer applies changes to draw context during painting process. Each
extended UI has its own set of layers. It can currently include changes to
font bold and italic attributes, and foreground and background color (and
probably more in future). These changes are made by draw layer to draw
context in updateContext() method. Draw layers form
double-linked lists. Renderer goes through this list every time it draws the
tokens of the text. A layer can work either by returning the
next-activity-change-offset or by being activated through the draw-marks that
it places at the appropriate positions or it can mix these two approaches.
author:
Miloslav Metelka
version:
1.00 |
| Inner Class :abstract public static class AbstractLayer implements DrawLayer | |
| Method Summary | |
| public boolean | extendsEOL()
Whether the layer wants to use the last context's background till the end
of the window or not. | | public boolean | extendsEmptyLine()
Whether the layer marks the empty line with the background by half of the
character. | | public String | getName()
Get the name of the layer. | | public int | getNextActivityChangeOffset(DrawContext ctx)
Get the next position at which the activity of the layer will change. | | public void | init(DrawContext ctx)
Called each time the paint begins for all layers in the layer chain
regardless whether they are currently active or not. | | public boolean | isActive(DrawContext ctx, MarkFactory.DrawMark mark)
Return whether the layer is active or not. | | public void | updateContext(DrawContext ctx)
Update draw context by setting colors, fonts and possibly other draw
properties. | | public int | updateLineNumberContext(int lineNumber, DrawContext ctx)
Update draw context related to the drawing of line number for the given
line by setting colors, fonts and possibly other draw properties. |
| extendsEOL | | public boolean extendsEOL()(Code) | | Whether the layer wants to use the last context's background till the end
of the window or not.
|
| extendsEmptyLine | | public boolean extendsEmptyLine()(Code) | | Whether the layer marks the empty line with the background by half of the
character.
|
| getName | | public String getName()(Code) | | Get the name of the layer. The layers that should work together over one
component must have the different names.
|
| getNextActivityChangeOffset | | public int getNextActivityChangeOffset(DrawContext ctx)(Code) | | Get the next position at which the activity of the layer will change. It
can return Integer.MAX_VALUE to mark that the activity will
never change or if it will change only by draw-marks. When this position
will be reached the isActive will be called.
|
| init | | public void init(DrawContext ctx)(Code) | | Called each time the paint begins for all layers in the layer chain
regardless whether they are currently active or not. It is intended to
prepare the layer. It doesn't need to set the next-activity-change-offset
because isActive() will be called at the begining of the
drawing when this method finishes.
|
| isActive | | public boolean isActive(DrawContext ctx, MarkFactory.DrawMark mark)(Code) | | Return whether the layer is active or not. This method is called at the
begining of the drawing, then each time when the draw-mark is found at
the current fragment offset or when drawing reaches the
next-activity-change-offset of this layer (mark parameter is null in this
case). The layer must return whether it wants to be active for the next
drawing or not. The layer should also consider changing the
next-activity-change-offset because the draw-engine will ask for it after
this method finishes. If the mark is found at the same position like
next-activity-change-offset is, then this method is called only once with
the valid mark parameter.
Parameters:
ctx - current context with the information about the drawing
Parameters:
mark - draw-mark at the fragment-offset or null if called because ofthe next-activity-change-offset. |
| updateContext | | public void updateContext(DrawContext ctx)(Code) | | Update draw context by setting colors, fonts and possibly other draw
properties. The method can use information from the context to find where
the painting process is currently located. It is called only if the layer
is active.
|
| updateLineNumberContext | | public int updateLineNumberContext(int lineNumber, DrawContext ctx)(Code) | | Update draw context related to the drawing of line number for the given
line by setting colors, fonts and possibly other draw properties. The
method can also change the current line number by returning the modified
line-number than the original one. At the begining the first layer gets
the line-number lineOffset + 1 but some layers can change it.
If the layer doesn't want to change the line-number it should return the
same value as it gets. The context can be affected to change the font and
colors for the line-number. The context's getFragmentOffset()
returns the begining of the line. The following methods in the context
return undefined values:
isEOL(), getBuffer(), getTokenID(), getTokenOffset(), getTokenLength().
The process of calling this method is independent of the status of the
layers and is called for each layer even if it's not active.
Parameters:
lineNumber - the number that will be drawn before the line's text. Thelayer can change it by returning a different value.
Parameters:
ctx - the draw context |
|
|