org.xwiki.gwt.wysiwyg.client.plugin.macro.ui
Class SelectMacroWizardStep

java.lang.Object
  org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep
      org.xwiki.gwt.user.client.ui.wizard.AbstractInteractiveWizardStep
          org.xwiki.gwt.wysiwyg.client.plugin.macro.ui.AbstractMacroWizardStep
              org.xwiki.gwt.wysiwyg.client.plugin.macro.ui.SelectMacroWizardStep

All Implemented Interfaces:

com.google.gwt.event.dom.client.DoubleClickHandler, com.google.gwt.event.dom.client.KeyUpHandler, com.google.gwt.event.shared.EventHandler, SourcesNavigationEvents, WizardStep, Updatable

Direct Known Subclasses:

SelectGadgetWizardStep

public class SelectMacroWizardStep
extends AbstractMacroWizardStep
implements com.google.gwt.event.dom.client.DoubleClickHandler, com.google.gwt.event.dom.client.KeyUpHandler, SourcesNavigationEvents, Updatable

Wizard step for selecting one of the available macros.

Version:

$Id: ceb6086e5ab3d56457410be9ba71a1c62412537c $

Constructor Summary

SelectMacroWizardStep(Config config, MacroServiceAsync macroService)
Creates a new wizard step for selecting one of the available macros.

Method Summary

void	addNavigationListener(NavigationListener listener)
boolean	canUpdate()
Object	getResult()
String	getStepTitle()
protected com.google.gwt.user.client.ui.Label	getValidationMessage()
void	init(Object data, com.google.gwt.user.client.rpc.AsyncCallback<?> initCallback)
void	onCancel()
void	onDoubleClick(com.google.gwt.event.dom.client.DoubleClickEvent event)
void	onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)
void	onSubmit(com.google.gwt.user.client.rpc.AsyncCallback<Boolean> async)
void	removeNavigationListener(NavigationListener listener)
void	update() Updates the macroList based on the chosen category and specified search query.

Methods inherited from class org.xwiki.gwt.wysiwyg.client.plugin.macro.ui.AbstractMacroWizardStep

getConfig, getMacroService

Methods inherited from class org.xwiki.gwt.user.client.ui.wizard.AbstractInteractiveWizardStep

display, isAutoSubmit, setStepTitle

Methods inherited from class org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep

getDirectionName, getNextStep, getValidDirections, setDirectionName, setNextStep, setValidDirections

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectMacroWizardStep

public SelectMacroWizardStep(Config config,
                             MacroServiceAsync macroService)

Creates a new wizard step for selecting one of the available macros.

Parameters:

config - the object used to configure the newly created wizard step

macroService - the macro service used to retrieve macro descriptors

Method Detail

getResult

public Object getResult()

Specified by:

getResult in interface WizardStep

See Also:

WizardStep.getResult()

getStepTitle

public String getStepTitle()

Specified by:

getStepTitle in interface WizardStep

Overrides:

getStepTitle in class AbstractInteractiveWizardStep

See Also:

AbstractInteractiveWizardStep.getStepTitle()

init

public void init(Object data,
                 com.google.gwt.user.client.rpc.AsyncCallback<?> initCallback)

Specified by:

init in interface WizardStep

See Also:

WizardStep.init(Object, AsyncCallback)

onCancel

public void onCancel()

Specified by:

onCancel in interface WizardStep

See Also:

WizardStep.onCancel()

onSubmit

public void onSubmit(com.google.gwt.user.client.rpc.AsyncCallback<Boolean> async)

Specified by:

onSubmit in interface WizardStep

See Also:

WizardStep.onSubmit(AsyncCallback)

onDoubleClick

public void onDoubleClick(com.google.gwt.event.dom.client.DoubleClickEvent event)

Specified by:

onDoubleClick in interface com.google.gwt.event.dom.client.DoubleClickHandler

See Also:

DoubleClickHandler.onDoubleClick(DoubleClickEvent)

onKeyUp

public void onKeyUp(com.google.gwt.event.dom.client.KeyUpEvent event)

Specified by:

onKeyUp in interface com.google.gwt.event.dom.client.KeyUpHandler

See Also:

KeyUpHandler.onKeyUp(KeyUpEvent)

addNavigationListener

public void addNavigationListener(NavigationListener listener)

Specified by:

addNavigationListener in interface SourcesNavigationEvents

See Also:

SourcesNavigationEvents.addNavigationListener(NavigationListener)

removeNavigationListener

public void removeNavigationListener(NavigationListener listener)

Specified by:

removeNavigationListener in interface SourcesNavigationEvents

See Also:

SourcesNavigationEvents.removeNavigationListener(NavigationListener)

canUpdate

public boolean canUpdate()

Specified by:

canUpdate in interface Updatable

See Also:

Updatable.canUpdate()

update

public void update()

Updates the macroList based on the chosen category and specified search query.

Specified by:

update in interface Updatable

See Also:

Updatable.update()

getValidationMessage

protected com.google.gwt.user.client.ui.Label getValidationMessage()

Returns:

the validationMessage