com.ximpleware.extended
Class BookMarkHuge

java.lang.Object
  com.ximpleware.extended.BookMarkHuge

public class BookMarkHuge
extends java.lang.Object

Constructor Summary

BookMarkHuge()
Constructor for BookMark Take no argument

BookMarkHuge(VTDNavHuge vn)
BookMark constructor with an instance of vn as input

Method Summary

void	bind(VTDNavHuge vn) bind a BookMark object to a VTDNav object the cursor position is set to an invalid state
boolean	deepEquals(BookMarkHuge bm2)
boolean	equals(BookMarkHuge bm2)
boolean	equals(java.lang.Object obj)
VTDNavHuge	getNav() This method returns the embedded VTDNav Object
int	hashCode()
boolean	recordCursorPosition() Record cursor position of the VTDNav object as embedded in the bookmark
boolean	recordCursorPosition(VTDNavHuge vn) Record the cursor position This method is implemented to be lenient on loading in that it can load nodes from any VTDNav object if vn is null, return false
boolean	setCursorPosition(VTDNavHuge vn) set cursor position This method can only set the cursor position of an VTDNav object identical to its internal copy
boolean	setCursorPostion() Set the cursor position of VTDNav object corresponding to the internal reference position of the embedded VTDNav object
void	unbind() separate a bookMark object apart from its embedded VTDNav instance

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookMarkHuge

public BookMarkHuge()

Constructor for BookMark Take no argument

BookMarkHuge

public BookMarkHuge(VTDNavHuge vn)

BookMark constructor with an instance of vn as input

Parameters:

vn -

Method Detail

bind

public void bind(VTDNavHuge vn)

bind a BookMark object to a VTDNav object the cursor position is set to an invalid state

Parameters:

vn -

deepEquals

public final boolean deepEquals(BookMarkHuge bm2)

equals

public final boolean equals(BookMarkHuge bm2)

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getNav

public VTDNavHuge getNav()

This method returns the embedded VTDNav Object

Returns:

VTDNav

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

recordCursorPosition

public boolean recordCursorPosition()

Record cursor position of the VTDNav object as embedded in the bookmark

Returns:

recordCursorPosition

public boolean recordCursorPosition(VTDNavHuge vn)

Record the cursor position This method is implemented to be lenient on loading in that it can load nodes from any VTDNav object if vn is null, return false

Parameters:

vn -

Returns:

setCursorPosition

public boolean setCursorPosition(VTDNavHuge vn)

set cursor position This method can only set the cursor position of an VTDNav object identical to its internal copy

Parameters:

vn -

Returns:

setCursorPostion

public boolean setCursorPostion()

Set the cursor position of VTDNav object corresponding to the internal reference position of the embedded VTDNav object

Returns:

unbind

public void unbind()

separate a bookMark object apart from its embedded VTDNav instance