Package com.myscript.iink

Class ContentSelection

java.lang.Object

com.myscript.iink.ContentSelection

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ContentBlock

public class ContentSelection
extends Object
implements AutoCloseable

Represents a selection of content.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
@NotNull Rectangle	getBox()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2, use Editor.getBox(com.myscript.iink.ContentSelection) instead.
@NotNull EnumSet<ConversionState>	getConversionState()	Deprecated, for removal: This API element is subject to removal in a future version. since 3.2, use Editor.getConversionState(com.myscript.iink.ContentSelection) instead.
@Nullable ContentPart	getPart()	Returns the part that contains this selection.
boolean	isClosed()	Tells whether the close() method has been called.
boolean	isValid()	Tells whether this selection is still valid.
@NotNull String	toString()	Returns a String representation of the object, with its part type and box.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()

Specified by:

close in interface AutoCloseable

isClosed

public boolean isClosed()

Tells whether the close() method has been called. Once an object is closed any method will throw IllegalStateException.

Returns:

true if this object is closed.

getPart

@Nullable
public @Nullable ContentPart getPart()

Returns the part that contains this selection.

Note: do not close the returned object as it is owned by another entity.

Returns:

the content part.

Throws:

IllegalStateException - when this selection is closed.

IllegalStateException - when selection is invalid.

isValid

public boolean isValid()

Tells whether this selection is still valid. A selection becomes invalid when it is removed or when the currently edited part changes (see IEditorListener.partChanged(Editor).

Returns:

true if this selection is valid.

Throws:

IllegalStateException - when this selection is closed.

getBox

@Deprecated(forRemoval=true)
@NotNull
public @NotNull Rectangle getBox()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2, use Editor.getBox(com.myscript.iink.ContentSelection) instead.

Returns the box that represents the position of this selection.

Returns:

the selection (document coordinates in mm).

Throws:

IllegalStateException - when this selection is closed.

IllegalStateException - when selection is invalid.

getConversionState

@Deprecated(forRemoval=true)
@NotNull
public @NotNull EnumSet<ConversionState> getConversionState()

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.2, use Editor.getConversionState(com.myscript.iink.ContentSelection) instead.

Returns the current conversion state of this selection, as a set of ConversionState values.

Returns:

the conversion state of this selection.

Throws:

IllegalStateException - when this selection is closed.

IllegalStateException - when selection is invalid.

toString

@NotNull
public @NotNull String toString()

Returns a String representation of the object, with its part type and box.

Overrides:

toString in class Object

Returns:

the representation of the object.

Since:

2.1