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

Class ZoomToCommand

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.ZoomToCommand

All Implemented Interfaces:

Command

public final class ZoomToCommand
extends AbstractDocumentCommand

Provides absolute zooming behaviour.

This includes zoom in and zoom out behaviour. Defaults to 100% if no absolute 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.

Nested Class Summary

Nested classes/interfaces inherited from class com.levigo.jadice.web.client.commands.AbstractDocumentCommand

AbstractDocumentCommand.Scope

Constructor Summary

Constructors

Constructor	Description
ZoomToCommand()	Default Constructor.
ZoomToCommand(ZoomHelper zoomHelper)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected boolean	canExecute()	Checks if this command can be executed.
protected void	execute()	Executes this command.
String	getID()	The ID of the command.
ZoomToCommand	setZoomFactor(float zoomFactor)	Sets the absolute zoom factor.

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractDocumentCommand

getDocument, getRenderControls, getScope, setScope

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractMouseCommand

clearInjections, isDoubleClicked, setMouseEvent

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractPageViewCommand

getPageView, setPageView

Methods inherited from class com.levigo.jadice.web.client.commands.AbstractContextCommand

getContext, propagateContextChange, setContext

Methods inherited from class com.levigo.jadice.web.client.util.command.InjectedCommand

canExecute, execute, getKey, isSelected, isSelected, setKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.levigo.jadice.web.client.util.command.Command

isAvailable, isAvailable

Constructor Details

ZoomToCommand

public ZoomToCommand()

Default Constructor.

Initializes the zoom factor to 100%.

ZoomToCommand

@Deprecated
public ZoomToCommand(ZoomHelper zoomHelper)

Deprecated.

Method Details

setZoomFactor

public ZoomToCommand setZoomFactor(float zoomFactor)

Sets the absolute zoom factor.

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

Parameters:

zoomFactor - 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 absolute zoom factor by replacing the existing one. 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