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

Class CreateAnnotationViaApiCommand

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

All Implemented Interfaces:

Command

Direct Known Subclasses:

CreateMaskAnnoCommand, CreateTextAnnoWithDefaultTextCommand

public abstract class CreateAnnotationViaApiCommand
extends AbstractPageViewCommand

Creates an Annotation programmatically via Annotation API. In contrast: The standard way is to create an Annotation by user interaction on the UI.

Constructor Summary

Constructors

Constructor	Description
CreateAnnotationViaApiCommand()

Method Summary

Modifier and Type	Method	Description
protected boolean	canExecute()	Checks if the Command can be executed at the given time.
abstract void	configure(com.levigo.jadice.web.shared.model.annotation.internal.AnnotationPageSegment aps, Annotation annotation)	Fine-tunes the newly created Annotation.
protected Annotation	createAnnotation(AnnotationProfile profile, String annoType, com.levigo.jadice.web.shared.model.annotation.internal.AnnotationPageSegment aps)	Creates an Annotation that is not yet attached to the Document structure.
protected void	execute()	Executes the command to create an Annotation if the preconditions listed in the documentation of canExecute() are met.
abstract Page	getPageForNewAnnotation()	Override this method to set the page onto which the new Annotation shall be placed.
void	loadAnnotationProfile()	Loads an AnnotationProfile which is required to create a new Annotation.
void	setAnnotationType(String annotationType)	Sets the annotationType.
void	setProfileId(String profileId)	Sets the profileId.

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, clearInjections, 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

getID, isAvailable, isAvailable

Constructor Details

CreateAnnotationViaApiCommand

public CreateAnnotationViaApiCommand()

Method Details

setProfileId

public void setProfileId(String profileId)

Sets the profileId.

You must also call loadAnnotationProfile();

Parameters:

profileId - The profile ID as it is specified in the annotation profile XML file within the tag annotation-profile.

setAnnotationType

public void setAnnotationType(String annotationType)

Sets the annotationType.

Parameters:

annotationType - The Annotation type as it is defined within either the annotation-type or annotation-template tag in the annotation profile file.

loadAnnotationProfile

public void loadAnnotationProfile()

Loads an AnnotationProfile which is required to create a new Annotation.

After the AnnotationProfile is completely loaded, set the field profile. A non-null profile indicates that the command can now be executed.

getPageForNewAnnotation

public abstract Page getPageForNewAnnotation()

Override this method to set the page onto which the new Annotation shall be placed.

Returns:

The page onto the Annotation shall be placed.

createAnnotation

protected Annotation createAnnotation(AnnotationProfile profile,
 String annoType,
 com.levigo.jadice.web.shared.model.annotation.internal.AnnotationPageSegment aps)

Creates an Annotation that is not yet attached to the Document structure.

Parameters:

profile - The profile id as it is set in the annotation profile xml file within the tag annotation-profile.

annoType - The annotation type defining which specific subclass of Annotation to use.

aps - The AnnotationPageSegment for the new anno.

Returns:

The new Annotation.

execute

protected void execute()

Executes the command to create an Annotation if the preconditions listed in the documentation of canExecute() are met. Additionally the following calls must have been made before calling execute:

• setProfileId(String)
• setAnnotationType(String)
• loadAnnotationProfile()

If you want to execute this Command without using a JadiceButtonBuilder, you need to call the InjectedCommand.execute(Collection) method, providing the used PageView as single member of the Collection param.

Specified by:

execute in class InjectedCommand

configure

public abstract void configure(com.levigo.jadice.web.shared.model.annotation.internal.AnnotationPageSegment aps,
 Annotation annotation)

Fine-tunes the newly created Annotation.

Sets the still missing values like position and size of the Annotation, the text for a TextAnnotation, color values or line widths.

Parameters:

aps - The AnnotationPageSegment where the new Annotation shall be put on.

annotation - The new Annotation.

canExecute

protected boolean canExecute()

Checks if the Command can be executed at the given time.

Expected preconditions:

• the connected PageView is created and a valid Document is loaded.
• the Page retrieved by getPageForNewAnnotation() is loaded and has a valid ServerConnection object.
  
• a PageSegment is on the Page on the DocumentLayer.DEFAULT layer
• the needed profile is a loaded and valid AnnotationProfile object.

Overrides:

canExecute in class AbstractPageViewCommand

Returns:

True if the Command can be executed.