Package com.myscript.iink

Class ToolController

java.lang.Object

com.myscript.iink.ToolController

All Implemented Interfaces:

java.lang.AutoCloseable

public class ToolController
extends java.lang.Object
implements java.lang.AutoCloseable

The ToolController manages pointer tools configuration.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
@Nullable PointerTool	getToolForType(@NotNull PointerType type)	Returns the tool associated with a pointer type.
@Nullable java.lang.String	getToolStyle(@NotNull PointerTool tool)	Returns the CSS style properties associated with a pointer tool.
@Nullable java.lang.String	getToolStyleClasses(@NotNull PointerTool tool)	Returns the style classes associated with a pointer tool.
boolean	isClosed()	Tells whether the close() method has been called.
void	setToolForType(@NotNull PointerType type, @NotNull PointerTool tool)	Sets the tool associated with a pointer type.
void	setToolStyle(@NotNull PointerTool tool, @NotNull java.lang.String style)	Sets the CSS style properties associated with a pointer tool.
void	setToolStyleClasses(@NotNull PointerTool tool, @NotNull java.lang.String styleClasses)	Sets the style classes associated with a pointer tool.

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public final void close()

Specified by:

close in interface java.lang.AutoCloseable

isClosed

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

getToolForType

@Nullable
public final @Nullable PointerTool getToolForType(@NotNull
                                                  @NotNull PointerType type)

Returns the tool associated with a pointer type.

Parameters:

type - the pointer type.

Returns:

the pointer tool associated with this type.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalArgumentException - when type is unknown.

setToolForType

public final void setToolForType(@NotNull
                                 @NotNull PointerType type,
                                 @NotNull
                                 @NotNull PointerTool tool)

Sets the tool associated with a pointer type.

Parameters:

type - the pointer type.

tool - the pointer tool.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalStateException - when a pointer event sequence is in progress with this pointer type.

java.lang.IllegalArgumentException - when type is unknown.

java.lang.IllegalArgumentException - when tool is unknown.

getToolStyle

@Nullable
public final @Nullable java.lang.String getToolStyle(@NotNull
                                                     @NotNull PointerTool tool)

Returns the CSS style properties associated with a pointer tool.

Parameters:

tool - the pointer tool.

Returns:

the CSS style properties associated with this pointer tool.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalArgumentException - when tool is unknown.

setToolStyle

public final void setToolStyle(@NotNull
                               @NotNull PointerTool tool,
                               @NotNull
                               @NotNull java.lang.String style)

Sets the CSS style properties associated with a pointer tool.

Parameters:

tool - the pointer tool.

style - the tool CSS style properties.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalStateException - when a pointer event sequence is in progress with this pointer type.

java.lang.IllegalArgumentException - when tool is unknown.

getToolStyleClasses

@Nullable
public final @Nullable java.lang.String getToolStyleClasses(@NotNull
                                                            @NotNull PointerTool tool)

Returns the style classes associated with a pointer tool.

Parameters:

tool - the pointer tool.

Returns:

the style classes associated with this pointer tool.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalArgumentException - when tool is unknown.

setToolStyleClasses

public final void setToolStyleClasses(@NotNull
                                      @NotNull PointerTool tool,
                                      @NotNull
                                      @NotNull java.lang.String styleClasses)

Sets the style classes associated with a pointer tool. Note: style properties provided via `setToolStyle()` may override the styling associated with the style classes provided here.

Parameters:

tool - the pointer tool.

styleClasses - the style class names, separated by spaces.

Throws:

java.lang.IllegalStateException - when this tool controller is closed.

java.lang.IllegalArgumentException - when tool is unknown.