com.xpn.xwiki.wysiwyg.client.plugin.importer.ui
Class ImportOfficeFileWizardStep

java.lang.Object
  com.xpn.xwiki.wysiwyg.client.widget.wizard.util.AbstractFileUploadWizardStep
      com.xpn.xwiki.wysiwyg.client.plugin.importer.ui.ImportOfficeFileWizardStep

All Implemented Interfaces:

WizardStep

public class ImportOfficeFileWizardStep
extends AbstractFileUploadWizardStep

Wizard step responsible for importing the content of an office document into the wysiwyg editor.

Since:

2.0.1

Version:

$Id: ImportOfficeFileWizardStep.java 24761 2009-10-29 15:45:32Z mflorea $

Field Summary

Fields inherited from class com.xpn.xwiki.wysiwyg.client.widget.wizard.util.AbstractFileUploadWizardStep

FIELD_ERROR_STYLE

Constructor Summary

ImportOfficeFileWizardStep(Config config, ImportServiceAsync importService)
Instantiates the office document import wizard step.

Method Summary

com.google.gwt.user.client.ui.Widget	display()
java.lang.String	getDirectionName(NavigationListener.NavigationDirection direction)
protected java.lang.String	getFileHelpLabel()
protected java.util.Map<java.lang.String,java.lang.String>	getHTMLCleaningParams() Prepares the cleaning parameters map.
java.lang.String	getNextStep()
protected java.lang.String	getPage()
java.lang.Object	getResult()
protected java.lang.String	getSpace()
java.lang.String	getStepTitle()
java.util.EnumSet<NavigationListener.NavigationDirection>	getValidDirections()
protected java.lang.String	getWiki()
protected void	onAttachmentUploaded(Attachment attach, com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> async) Notifies the successful completion of a file upload, to be overridden by subclasses to provide specific behavior.

Methods inherited from class com.xpn.xwiki.wysiwyg.client.widget.wizard.util.AbstractFileUploadWizardStep

displayError, extractFileName, getFileLabel, getFileUploadInput, getFileUploadInputName, getMainPanel, getUploadURL, hideError, init, onCancel, onSubmit, onSubmitComplete, setWikiService

Methods inherited from class java.lang.Object

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

Constructor Detail

ImportOfficeFileWizardStep

public ImportOfficeFileWizardStep(Config config,
                                  ImportServiceAsync importService)

Instantiates the office document import wizard step.

Parameters:

config - the object used to configure this wizard step

importService - the component used to import office documents

Method Detail

display

public com.google.gwt.user.client.ui.Widget display()

Specified by:

display in interface WizardStep

Overrides:

display in class AbstractFileUploadWizardStep

getPage

protected java.lang.String getPage()

Specified by:

getPage in class AbstractFileUploadWizardStep

Returns:

the document to upload this file to, or null if the default document should be used.

getSpace

protected java.lang.String getSpace()

Specified by:

getSpace in class AbstractFileUploadWizardStep

Returns:

the space of the document to upload this file to, or null if the default space should be used.

getWiki

protected java.lang.String getWiki()

Specified by:

getWiki in class AbstractFileUploadWizardStep

Returns:

the wiki of the document to upload this file to, or null if the default wiki should be used.

getFileHelpLabel

protected java.lang.String getFileHelpLabel()

Specified by:

getFileHelpLabel in class AbstractFileUploadWizardStep

Returns:

the help label for the file input

onAttachmentUploaded

protected void onAttachmentUploaded(Attachment attach,
                                    com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> async)

Notifies the successful completion of a file upload, to be overridden by subclasses to provide specific behavior.

Specified by:

onAttachmentUploaded in class AbstractFileUploadWizardStep

Parameters:

attach - the successfully uploaded attachment

async - the call-back used to indicate the completion of this method. It's required that the sub-classes invoke async.onSuccess(true); method once they are done with processing the attachment. Without this method being invoked, the submission of this wizard step will not complete.

getResult

public java.lang.Object getResult()

getNextStep

public java.lang.String getNextStep()

getDirectionName

public java.lang.String getDirectionName(NavigationListener.NavigationDirection direction)

Specified by:

getDirectionName in interface WizardStep

Overrides:

getDirectionName in class AbstractFileUploadWizardStep

getStepTitle

public java.lang.String getStepTitle()

Specified by:

getStepTitle in interface WizardStep

Overrides:

getStepTitle in class AbstractFileUploadWizardStep

getValidDirections

public java.util.EnumSet<NavigationListener.NavigationDirection> getValidDirections()

Specified by:

getValidDirections in interface WizardStep

Overrides:

getValidDirections in class AbstractFileUploadWizardStep

getHTMLCleaningParams

protected java.util.Map<java.lang.String,java.lang.String> getHTMLCleaningParams()

Prepares the cleaning parameters map.

Returns:

a Map with cleaning parameters for office importer.