Package com.intellij.openapi.editor.impl.view

Class EditorView

java.lang.Object

com.intellij.openapi.editor.impl.view.EditorView

All Implemented Interfaces:

Dumpable, Disposable, VisibleAreaListener, TextDrawingCallback, java.awt.event.HierarchyListener, java.util.EventListener

public class EditorView
extends java.lang.Object
implements TextDrawingCallback, Disposable, Dumpable, java.awt.event.HierarchyListener, VisibleAreaListener

A facade for components responsible for drawing editor contents, managing editor size and coordinate conversions (offset <-> logical position <-> visual position <-> x,y). Also contains a cache of several font-related quantities (line height, space width, etc).

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
EditorView(EditorImpl editor)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
void	drawChars(java.awt.Graphics g, char [] data, int start, int end, int x, int y, java.awt.Color color, FontInfo fontInfo) Asks to draw symbols from [start; end) range of given char array at given graphics buffer using given font info and color.
java.lang.String	dumpState()
int	findNearestDirectionBoundary(int offset, boolean lookForward) Offset of nearest boundary (not equal to offset) on the same line is returned.
int	getAscent()
int	getBottomOverhang()
int	getCharHeight()
int	getDescent()
int	getLineHeight()
int	getMaxWidthInRange(int startOffset, int endOffset)
int	getNominalLineHeight()
float	getPlainSpaceWidth()
int	getPreferredHeight()
java.awt.Dimension	getPreferredSize()
int	getPreferredWidth(int beginLine, int endLine) Returns preferred pixel width of the lines in range.
float	getPrefixTextWidthInPixels()
int	getTabSize()
int	getTopOverhang()
void	hierarchyChanged(java.awt.event.HierarchyEvent e)
void	invalidateFoldRegionLayout(FoldRegion region)
void	invalidateRange(int startOffset, int endOffset)
boolean	isAtBidiRunBoundary(VisualPosition visualPosition)
boolean	isRtlLocation(VisualPosition visualPosition)
int	logicalPositionToOffset(LogicalPosition pos)
VisualPosition	logicalToVisualPosition(LogicalPosition pos, boolean beforeSoftWrap)
LogicalPosition	offsetToLogicalPosition(int offset)
int	offsetToVisualColumnInFoldRegion(FoldRegion region, int offset, boolean leanTowardsLargerOffsets)
int	offsetToVisualLine(int offset, boolean beforeSoftWrap)
VisualPosition	offsetToVisualPosition(int offset, boolean leanTowardsLargerOffsets, boolean beforeSoftWrap)
java.awt.geom.Point2D	offsetToXY(int offset, boolean leanTowardsLargerOffsets, boolean beforeSoftWrap)
void	paint(java.awt.Graphics2D g)
void	reinitSettings()
void	repaintCarets()
void	reset() Invoked when document might have changed, but no notifications were sent (for a hacky document in EditorTextFieldCellRenderer)
void	setPrefix(java.lang.String prefixText, TextAttributes attributes)
void	validateState()
void	visibleAreaChanged(VisibleAreaEvent e) Called when the editor is scrolled or resized.
int	visualColumnToOffsetInFoldRegion(FoldRegion region, int visualColumn, boolean leansRight)
int	visualLineToOffset(int visualLine)
int	visualLineToY(int line)
int	visualPositionToOffset(VisualPosition visualPosition)
java.awt.geom.Point2D	visualPositionToXY(VisualPosition pos)
LogicalPosition	visualToLogicalPosition(VisualPosition pos)
VisualPosition	xyToVisualPosition(java.awt.geom.Point2D p)
int	yToVisualLine(int y)

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorView

public EditorView(EditorImpl editor)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

hierarchyChanged

public void hierarchyChanged(java.awt.event.HierarchyEvent e)

Specified by:

hierarchyChanged in interface java.awt.event.HierarchyListener

visibleAreaChanged

public void visibleAreaChanged(VisibleAreaEvent e)

Description copied from interface: VisibleAreaListener

Called when the editor is scrolled or resized.

Specified by:

visibleAreaChanged in interface VisibleAreaListener

Parameters:

e - the event containing information about changes in the visible area of the editor.

yToVisualLine

public int yToVisualLine(int y)

visualLineToY

public int visualLineToY(int line)

offsetToLogicalPosition

public LogicalPosition offsetToLogicalPosition(int offset)

logicalPositionToOffset

public int logicalPositionToOffset(LogicalPosition pos)

logicalToVisualPosition

public VisualPosition logicalToVisualPosition(LogicalPosition pos,
                                              boolean beforeSoftWrap)

visualToLogicalPosition

public LogicalPosition visualToLogicalPosition(VisualPosition pos)

offsetToVisualPosition

public VisualPosition offsetToVisualPosition(int offset,
                                             boolean leanTowardsLargerOffsets,
                                             boolean beforeSoftWrap)

visualPositionToOffset

public int visualPositionToOffset(VisualPosition visualPosition)

offsetToVisualLine

public int offsetToVisualLine(int offset,
                              boolean beforeSoftWrap)

visualLineToOffset

public int visualLineToOffset(int visualLine)

xyToVisualPosition

public VisualPosition xyToVisualPosition(java.awt.geom.Point2D p)

visualPositionToXY

public java.awt.geom.Point2D visualPositionToXY(VisualPosition pos)

offsetToXY

public java.awt.geom.Point2D offsetToXY(int offset,
                                        boolean leanTowardsLargerOffsets,
                                        boolean beforeSoftWrap)

setPrefix

public void setPrefix(java.lang.String prefixText,
                      TextAttributes attributes)

getPrefixTextWidthInPixels

public float getPrefixTextWidthInPixels()

paint

public void paint(java.awt.Graphics2D g)

repaintCarets

public void repaintCarets()

getPreferredSize

public java.awt.Dimension getPreferredSize()

getPreferredWidth

public int getPreferredWidth(int beginLine,
                             int endLine)

Returns preferred pixel width of the lines in range.

This method is currently used only with "idea.true.smooth.scrolling" experimental option.

Parameters:

beginLine - begin visual line (inclusive)

endLine - end visual line (exclusive), may be greater than the actual number of lines

Returns:

preferred pixel width

getPreferredHeight

public int getPreferredHeight()

getMaxWidthInRange

public int getMaxWidthInRange(int startOffset,
                              int endOffset)

reinitSettings

public void reinitSettings()

invalidateRange

public void invalidateRange(int startOffset,
                            int endOffset)

reset

public void reset()

Invoked when document might have changed, but no notifications were sent (for a hacky document in EditorTextFieldCellRenderer)

isRtlLocation

public boolean isRtlLocation(VisualPosition visualPosition)

isAtBidiRunBoundary

public boolean isAtBidiRunBoundary(VisualPosition visualPosition)

findNearestDirectionBoundary

public int findNearestDirectionBoundary(int offset,
                                        boolean lookForward)

Offset of nearest boundary (not equal to offset) on the same line is returned. -1 is returned if corresponding boundary is not found.

getPlainSpaceWidth

public float getPlainSpaceWidth()

getNominalLineHeight

public int getNominalLineHeight()

getLineHeight

public int getLineHeight()

getDescent

public int getDescent()

getCharHeight

public int getCharHeight()

getAscent

public int getAscent()

getTopOverhang

public int getTopOverhang()

getBottomOverhang

public int getBottomOverhang()

getTabSize

public int getTabSize()

offsetToVisualColumnInFoldRegion

public int offsetToVisualColumnInFoldRegion(FoldRegion region,
                                            int offset,
                                            boolean leanTowardsLargerOffsets)

visualColumnToOffsetInFoldRegion

public int visualColumnToOffsetInFoldRegion(FoldRegion region,
                                            int visualColumn,
                                            boolean leansRight)

invalidateFoldRegionLayout

public void invalidateFoldRegionLayout(FoldRegion region)

drawChars

public void drawChars(java.awt.Graphics g,
                      char [] data,
                      int start,
                      int end,
                      int x,
                      int y,
                      java.awt.Color color,
                      FontInfo fontInfo)

Description copied from interface: TextDrawingCallback

Asks to draw symbols from [start; end) range of given char array at given graphics buffer using given font info and color.

Specified by:

drawChars in interface TextDrawingCallback

Parameters:

g - graphics buffer to use

data - target symbols holder

start - start offset within the symbols holder to use (inclusive)

end - end offset within the symbols holder to use (inclusive)

x - 'x' coordinate to use as a start position at the given graphics buffer

y - 'y' coordinate to use as a start position at the given graphics buffer

color - color to use during drawing target text at the given graphics buffer

fontInfo - font info to use during drawing target text at the given graphics buffer

dumpState

public java.lang.String dumpState()

Specified by:

dumpState in interface Dumpable

validateState

public void validateState()