Package com.myscript.iink

Class ToolController

java.lang.Object
com.myscript.iink.ToolController
All Implemented Interfaces:
AutoCloseable
public class ToolController extends Object implements AutoCloseable
The ToolController manages pointer tools configuration.

  • Method Details

    • finalize

      protected void finalize() throws Throwable
      Overrides:
      finalize in class Object
      Throws:
      Throwable

    • close

      public final void close()
      Specified by:
      close in interface 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:
      IllegalStateException - when this tool controller is closed.
      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:
      IllegalStateException - when this tool controller is closed.
      IllegalStateException - when a pointer event sequence is in progress with this pointer type.
      IllegalArgumentException - when type is unknown.
      IllegalArgumentException - when tool is unknown.

    • getToolStyle

      @Nullable public final @Nullable 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:
      IllegalStateException - when this tool controller is closed.
      IllegalArgumentException - when tool is unknown.

    • setToolStyle

      public final void setToolStyle(@NotNull @NotNull PointerTool tool, @NotNull @NotNull String style)
      Sets the CSS style properties associated with a pointer tool.
      Parameters:
      tool - the pointer tool.
      style - the tool CSS style properties.
      Throws:
      IllegalStateException - when this tool controller is closed.
      IllegalStateException - when a pointer event sequence is in progress with this pointer type.
      IllegalArgumentException - when tool is unknown.

    • getToolStyleClasses

      @Nullable public final @Nullable 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:
      IllegalStateException - when this tool controller is closed.
      IllegalArgumentException - when tool is unknown.

    • setToolStyleClasses

      public final void setToolStyleClasses(@NotNull @NotNull PointerTool tool, @NotNull @NotNull 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:
      IllegalStateException - when this tool controller is closed.
      IllegalArgumentException - when tool is unknown.

    • toString

      @NotNull public @NotNull String toString()
      Returns a String representation of the object, with the current mapping of pointer tools and types.
      Overrides:
      toString in class Object
      Returns:
      the representation of the object.
      Since:
      2.1