LPEX
3.6.8

com.ibm.lpex.core
Class LpexDocumentLocation

java.lang.Object
  extended by com.ibm.lpex.core.LpexDocumentLocation

public class LpexDocumentLocation
extends Object

This class is used to represent a location in a document (or in the document section that is currently loaded in the editor).

See Also:
LpexView

Field Summary
 int element
          The element number.
 int position
          The position within the element.
 
Constructor Summary
LpexDocumentLocation(int element, int position)
          This constructor creates a document location object for the given position in the specified element.
LpexDocumentLocation(LpexDocumentLocation documentLocation)
          This constructor creates a document location object representing the same location as the specified documentLocation.
 
Method Summary
 boolean equals(LpexDocumentLocation documentLocation)
          Returns whether two document locations are equal.
 String toString()
          Return a String representation of this LpexDocumentLocation suitable for debugging purposes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

element

public int element
The element number. The number of the first document element is 1.


position

public int position
The position within the element. The position of the first character within an element is 1.

Constructor Detail

LpexDocumentLocation

public LpexDocumentLocation(int element,
                            int position)
This constructor creates a document location object for the given position in the specified element.


LpexDocumentLocation

public LpexDocumentLocation(LpexDocumentLocation documentLocation)
This constructor creates a document location object representing the same location as the specified documentLocation.

Method Detail

equals

public boolean equals(LpexDocumentLocation documentLocation)
Returns whether two document locations are equal.


toString

public String toString()
Return a String representation of this LpexDocumentLocation suitable for debugging purposes.

Overrides:
toString in class Object

LPEX
3.6.8

Copyright © 2013 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.