Package com.levigo.jadice.web.client.commands

Class ZoomCommand

java.lang.Object
com.levigo.jadice.web.client.util.command.InjectedCommand
com.levigo.jadice.web.client.commands.AbstractContextCommand
com.levigo.jadice.web.client.commands.AbstractPageViewCommand
com.levigo.jadice.web.client.commands.AbstractMouseCommand
com.levigo.jadice.web.client.commands.AbstractDocumentCommand
com.levigo.jadice.web.client.commands.ZoomCommand
All Implemented Interfaces:
Command
public final class ZoomCommand extends AbstractDocumentCommand
Provides relative zooming behaviour.

This includes zoom in and zoom out behaviour on a relative base. Defaults to 10% steps if no relative zoom factor is supplied by the caller.

Zooming behaviour can be configured to be document- or page specific by using the underlying AbstractDocumentCommand.setScope(Scope) method.

  • Constructor Details

    • ZoomCommand

      public ZoomCommand()
      Default Constructor. Initializes this command to provide zoom in behaviour.

    • ZoomCommand

      public ZoomCommand(boolean zoomIn)
      Constructor.
      Parameters:
      zoomIn - if true zoom in behaviour is configured, if false zoom out behaviour is configured.

    • ZoomCommand

      @Deprecated public ZoomCommand(ZoomHelper zoomHelper, float zoomRelative)
      Deprecated.

  • Method Details

    • setZoomRelative

      public ZoomCommand setZoomRelative(float zoomRelative)
      Sets the relative zoom factor.

      The @Parameter annotation allows to wire command params. See examples in com.levigo.jadice.web.demo.common.server.DefaultDescriptorService.

      Parameters:
      zoomRelative - the relative zoom factor that will be applied when execute() is called
      Returns:
      this command instance

    • canExecute

      protected boolean canExecute()
      Checks if this command can be executed.
      Overrides:
      canExecute in class AbstractDocumentCommand
      Returns:
      true, if execute() can be called, false else

    • execute

      protected void execute()
      Executes this command.

      Applies the relative zoom factor to the existing one by mathematically adding it. The underlying AbstractDocumentCommand.getRenderControls(boolean) decides on the given AbstractDocumentCommand.Scope if a document specific zoom or a page specific zoom is performed.

      If a document wide zoom is executed all page render settings zoom factors will be overridden.

      Specified by:
      execute in class InjectedCommand

    • getID

      public String getID()
      Description copied from interface: Command
      The ID of the command. This is typically the command class name. If the Command is parameterized the ID should comprise the class name + parameter information.
      Specified by:
      getID in interface Command
      Overrides:
      getID in class AbstractDocumentCommand
      Returns:
      the ID of the command