com.myscript.iink

Class ContentBlock

java.lang.Object

com.myscript.iink.ContentBlock

public class ContentBlock
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTAINER_TYPE The value returned by getType() for container blocks.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttributes() Returns the block's attributes as a JSON string.
Rectangle	getBox() Returns the box that represents the position of this block.
ContentBlock[]	getChildren() Returns the children of this block.
java.util.EnumSet<ConversionState>	getConversionState() Returns the current conversion state of this block, as a set of ConversionState values.
java.lang.String	getId() Returns the identifier of this block.
ContentBlock	getParent() Returns the parent of this block.
ContentPart	getPart() Returns the part that contains this block.
java.lang.String	getRenderingId() Returns an identifier that can be used to match corresponding calls to ICanvas.startGroup(String, float, float, float, float, boolean).
java.lang.String	getType() Returns the type of this block.
boolean	isValid() Tells whether this block is still valid.

Methods inherited from class java.lang.Object

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

Field Detail

CONTAINER_TYPE

public static final java.lang.String CONTAINER_TYPE

The value returned by getType() for container blocks.

See Also:

Constant Field Values

Method Detail

getPart

public final ContentPart getPart()

Returns the part that contains this block.

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

Returns:

the content part.

isValid

public final boolean isValid()

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

Returns:

true if this block is valid.

getType

public final java.lang.String getType()

Returns the type of this block.

Returns:

the type name.

getId

public final java.lang.String getId()

Returns the identifier of this block.

Returns:

the identifier.

getRenderingId

public final java.lang.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.

getAttributes

public final java.lang.String getAttributes()

Returns the block's attributes as a JSON string.

Returns:

the attributes.

Since:

1.1

getBox

public final Rectangle getBox()

Returns the box that represents the position of this block.

Returns:

the box (document coordinates in mm).

getChildren

public final 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.

getConversionState

public final java.util.EnumSet<ConversionState> getConversionState()

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

Returns:

the conversion state of this block.

getParent

public final ContentBlock getParent()

Returns the parent of this block.

Returns:

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

Since:

1.4