Package com.myscript.iink

Class ContentBlock

java.lang.Object

com.myscript.iink.ContentSelection

com.myscript.iink.ContentBlock

All Implemented Interfaces:

AutoCloseable

public class ContentBlock
extends ContentSelection

Represents a block of content. The tree of content blocks provides the hierarchical structure of a content part into semantic units.

Method Summary

Modifier and Type	Method	Description
final void	close()
protected void	finalize()
final @NotNull String	getAttributes()	Returns the block's attributes as a JSON string.
@NotNull Rectangle	getBox()	Returns the box that represents the position of this block.
final @NotNull ContentBlock[]	getChildren()	Returns the children of this block.
@NotNull EnumSet<ConversionState>	getConversionState()	Returns the current conversion state of this block, as a set of ConversionState values.
final @NotNull String	getId()	Returns the identifier of this block.
final @Nullable ContentBlock	getParent()	Returns the parent of this block.
final @NotNull String	getRenderingId()	Returns an identifier that can be used to match corresponding calls to ICanvas.startGroup(String, float, float, float, float, boolean).
final @NotNull String	getType()	Returns the type of this block.
final boolean	isClosed()	Tells whether the close() method has been called.
final @NotNull String	toString()	Returns a String representation of the object.

Methods inherited from class com.myscript.iink.ContentSelection

getPart, isValid

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 ContentSelection

Throws:

Throwable

close

public final void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class ContentSelection

isClosed

public final boolean isClosed()

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

Overrides:

isClosed in class ContentSelection

Returns:

true if this object is closed.

getType

@NotNull
public final @NotNull String getType()

Returns the type of this block.

Returns:

the type name.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

getId

@NotNull
public final @NotNull String getId()

Returns the identifier of this block.

Returns:

the identifier.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

getRenderingId

@NotNull
public final @NotNull String getRenderingId()

Returns an identifier that can be used to match corresponding calls to ICanvas.startGroup(String, float, float, float, float, boolean).

Returns:

the rendering identifier.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

getAttributes

@NotNull
public final @NotNull String getAttributes()

Returns the block's attributes as a JSON string.

Returns:

the attributes.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

Since:

1.1

getChildren

@NotNull
public final @NotNull ContentBlock[] getChildren()

Returns the children of this block. The returned array is a copy of the list of child blocks, which makes it safe against concurrent changes.

Returns:

an array of the child blocks.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

getParent

@Nullable
public final @Nullable ContentBlock getParent()

Returns the parent of this block.

Returns:

the parent of this block, or null if this block is the root block.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

Since:

1.4

getBox

@NotNull
public @NotNull Rectangle getBox()

Returns the box that represents the position of this block.

Returns:

the block (document coordinates in mm).

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

getConversionState

@NotNull
public @NotNull EnumSet<ConversionState> getConversionState()

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

Returns:

the conversion state of this block.

Throws:

IllegalStateException - when this block is closed.

IllegalStateException - when block is invalid.

toString

@NotNull
public final @NotNull String toString()

Returns a String representation of the object.

Overrides:

toString in class ContentSelection

Returns:

the representation of the object.

Since:

2.1