|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A vertical ruler is a visual component which may serve text viewers as an
annotation presentation area. The vertical ruler info provides interested
clients with the mapping and interaction aspect of the vertical ruler. This
covers the mapping between coordinates of the ruler's control and line
numbers based on the connected text viewer's document.
In order to provide backward compatibility for clients of
IVerticalRulerInfo
, extension interfaces are used as a means
of evolution. The following extension interfaces exist:
IVerticalRulerInfoExtension
since
version 3.0 allowing custom annotation hovers and specific annotation models.
IVerticalRulerInfoExtension
Method Summary | |
Control |
getControl()
Returns the ruler's SWT control. |
int |
getLineOfLastMouseButtonActivity()
Returns the line number of the last mouse button activity. |
int |
getWidth()
Returns the width of this ruler's control. |
int |
toDocumentLineNumber(int y_coordinate)
Translates a y-coordinate of the ruler's SWT control into the according line number of the document of the connected text viewer. |
Method Detail |
public Control getControl()
public int getLineOfLastMouseButtonActivity()
0
.
public int toDocumentLineNumber(int y_coordinate)
y_coordinate
- a y-coordinate of the ruler's SWT control
-1
if that
coordinate does not correspond to a valid document linepublic int getWidth()
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.