LPEX
3.6.7

com.ibm.lpex.alef
Class LpexCompositeRuler

java.lang.Object
  extended by CompositeRuler
      extended by com.ibm.lpex.alef.LpexCompositeRuler

public class LpexCompositeRuler
extends CompositeRuler

A composite vertical ruler which is connected to an LpexTextViewer.

This ruler does not have a a visual representation of its own. The presentation comes from the configurable list of vertical ruler columns. Such columns must implement the IVerticalRulerColumn interface.

Clients may instantiate and configure this class.


Constructor Summary
LpexCompositeRuler()
          Constructs a new composite vertical ruler.
LpexCompositeRuler(int gap)
          Constructs a new composite ruler with the given gap between its columns.
 
Method Summary
 int toDocumentLineNumber(int y_coordinate)
          Translates a y-coordinate of the vertical ruler's SWT Control into the corresponding ZERO-based line number of the input document section of the connected LpexTextViewer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LpexCompositeRuler

public LpexCompositeRuler()
Constructs a new composite vertical ruler.


LpexCompositeRuler

public LpexCompositeRuler(int gap)
Constructs a new composite ruler with the given gap between its columns.

Parameters:
gap - between-columns gap
Method Detail

toDocumentLineNumber

public int toDocumentLineNumber(int y_coordinate)
Translates a y-coordinate of the vertical ruler's SWT Control into the corresponding ZERO-based line number of the input document section of the connected LpexTextViewer. The vertical ruler works with the text viewer's primary LpexWindow and its LpexView.

Returns:
ZERO-based document-section line number, or
-1 if no corresponding document-section line
See Also:
IVerticalRuler

LPEX
3.6.7

Copyright © 2012 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.