org.xwiki.gwt.wysiwyg.client.plugin.image.ui
Class ImageSelectorAggregatorWizardStep

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractSelectorWizardStep<T>
      org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractSelectorAggregatorWizardStep<EntityLink<C>>
          org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractEntitySelectorAggregatorWizardStep<T>
              org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AttachmentSelectorAggregatorWizardStep<ImageConfig>
                  org.xwiki.gwt.wysiwyg.client.plugin.image.ui.ImageSelectorAggregatorWizardStep

All Implemented Interfaces:

com.google.gwt.event.logical.shared.SelectionHandler<java.lang.Integer>, com.google.gwt.event.shared.EventHandler, NavigationListener, SourcesNavigationEvents, WizardStep

public class ImageSelectorAggregatorWizardStep
extends AttachmentSelectorAggregatorWizardStep<ImageConfig>

Allows the user to select an image from different locations: edited page attachments, all attachments or external URL.

Version:

$Id: ImageSelectorAggregatorWizardStep.java 31743 2010-10-13 01:20:32Z mflorea $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.gwt.user.client.ui.wizard.NavigationListener

NavigationListener.NavigationDirection

Constructor Summary

ImageSelectorAggregatorWizardStep(boolean selectionLimitedToCurrentPage, boolean allowExternalImage, WikiServiceAsync wikiService)
Creates a new wizard step that aggregates multiple views for selecting an image from different location.

Method Summary

protected java.lang.String	getRequiredStep()
protected WizardStep	getStepInstance(java.lang.String name)
protected java.util.List<java.lang.String>	getStepNames()

Methods inherited from class org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AttachmentSelectorAggregatorWizardStep

getStepTitle, setAllPagesSelector, setCurrentPageSelector, setStepTitle

Methods inherited from class org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractEntitySelectorAggregatorWizardStep

getWikiService, init

Methods inherited from class org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractSelectorAggregatorWizardStep

addNavigationListener, display, getDefaultStepName, getDirectionName, getNextStep, getResult, getStep, onCancel, onDirection, onSelection, onSubmit, removeNavigationListener, selectTab

Methods inherited from class org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractSelectorWizardStep

getData, getValidDirections, initializeSelection, setActive

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageSelectorAggregatorWizardStep

public ImageSelectorAggregatorWizardStep(boolean selectionLimitedToCurrentPage,
                                         boolean allowExternalImage,
                                         WikiServiceAsync wikiService)

Creates a new wizard step that aggregates multiple views for selecting an image from different location.

Parameters:

selectionLimitedToCurrentPage - true to limit the image selection to the attachments of the edited page, false to allow images to be selected from all pages

allowExternalImage - true to allow the user to select an external image by specifying its URL, false otherwise

wikiService - the object used to access the image attachments

Method Detail

getRequiredStep

protected java.lang.String getRequiredStep()

Overrides:

getRequiredStep in class AttachmentSelectorAggregatorWizardStep<ImageConfig>

Returns:

the name of the step required to be loaded by the current created or edited element, if any, or null otherwise (if previous selection should be preserved). To be overwritten by subclasses to detect whether the data being handled requires the "all pages" step to be loaded or not.

See Also:

AttachmentSelectorAggregatorWizardStep.getRequiredStep()

getStepInstance

protected WizardStep getStepInstance(java.lang.String name)

Overrides:

getStepInstance in class AttachmentSelectorAggregatorWizardStep<ImageConfig>

Parameters:

name - the name of the step to initialize

Returns:

an instance of the step recognized by the passed name

See Also:

AttachmentSelectorAggregatorWizardStep.getStepInstance(String)

getStepNames

protected java.util.List<java.lang.String> getStepNames()

Overrides:

getStepNames in class AttachmentSelectorAggregatorWizardStep<ImageConfig>

Returns:

the list of all step names

See Also:

AttachmentSelectorAggregatorWizardStep.getStepNames()