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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Composite
              org.xwiki.gwt.user.client.ui.wizard.AbstractCompositeWizardStep
                  org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep
                      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, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, SourcesNavigationEvents, WizardStep, Updatable

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: SelectMacroWizardStep.java 26786 2010-02-07 16:46:17Z mflorea $

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

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()
java.lang.Object	getResult()
java.lang.String	getStepTitle()
void	init(java.lang.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<java.lang.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.AbstractNavigationAwareWizardStep

getDirectionName, getNextStep, getValidDirections, setDirectionName, setNextStep, setValidDirections

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

display, getPanel

Methods inherited from class com.google.gwt.user.client.ui.Composite

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget

Methods inherited from class com.google.gwt.user.client.ui.Widget

addDomHandler, addHandler, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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 java.lang.Object getResult()

Specified by:

getResult in interface WizardStep

See Also:

WizardStep.getResult()

getStepTitle

public java.lang.String getStepTitle()

Specified by:

getStepTitle in interface WizardStep

See Also:

WizardStep.getStepTitle()

init

public void init(java.lang.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<java.lang.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()