org.xwiki.gwt.wysiwyg.client.plugin.link.ui

Class AbstractPageListSelectorWizardStep

java.lang.Object

org.xwiki.gwt.user.client.ui.wizard.AbstractNavigationAwareWizardStep

org.xwiki.gwt.user.client.ui.wizard.AbstractInteractiveWizardStep

org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractSelectorWizardStep<D>

org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractListSelectorWizardStep<EntityLink<C>,E>

org.xwiki.gwt.wysiwyg.client.widget.wizard.util.AbstractEntityListSelectorWizardStep<LinkConfig,WikiPage>

org.xwiki.gwt.wysiwyg.client.plugin.link.ui.AbstractPageListSelectorWizardStep

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

Direct Known Subclasses:

RecentChangesSelectorWizardStep, SearchSelectorWizardStep

public abstract class AbstractPageListSelectorWizardStep
extends AbstractEntityListSelectorWizardStep<LinkConfig,WikiPage>

Wizard step to select the wiki page to link to, from a list of wiki pages.

Version:

$Id: 9b8923e01d64a01a07f8af391e3fc9ee5fd7e211 $

Constructor Summary

Constructors

Constructor and Description
AbstractPageListSelectorWizardStep(WikiServiceAsync wikiService) Creates a new selector.

Method Summary

Modifier and Type	Method and Description
protected ListItem<WikiPage>	getListItem(WikiPage data)
protected ListItem<WikiPage>	getNewOptionListItem()
String	getNextStep()
protected String	getSelectErrorMessage()
protected String	getSelectHelpLabel()
protected WikiServiceAsync	getWikiService()
protected String	serializeDocumentReference(WikiPageReference reference) Serializes a document reference to be displayed to the user.

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

isSelectedByDefault, saveSelectedValue

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

addNavigationListener, display, displayError, fetchData, fillList, getErrorLabel, getList, getSelectedItem, hideError, init, onCancel, onDoubleClick, onKeyUp, onSubmit, refreshList, removeNavigationListener, setActive, setNewOptionOnTop

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

getData, getResult, initializeSelection

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

getStepTitle, isAutoSubmit, setStepTitle

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

getDirectionName, getValidDirections, setDirectionName, setNextStep, setValidDirections

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPageListSelectorWizardStep

public AbstractPageListSelectorWizardStep(WikiServiceAsync wikiService)

Creates a new selector.

Parameters:

wikiService - the service used to access the wiki

Method Detail

getSelectHelpLabel

protected String getSelectHelpLabel()

Specified by:

getSelectHelpLabel in class AbstractListSelectorWizardStep<EntityLink<LinkConfig>,WikiPage>

Returns:

the help label for this selector step.

getSelectErrorMessage

protected String getSelectErrorMessage()

Specified by:

getSelectErrorMessage in class AbstractListSelectorWizardStep<EntityLink<LinkConfig>,WikiPage>

Returns:

the error message to be displayed in case of an error in selection

getListItem

protected ListItem<WikiPage> getListItem(WikiPage data)

Specified by:

getListItem in class AbstractListSelectorWizardStep<EntityLink<LinkConfig>,WikiPage>

Parameters:

data - the data to build a list item representation for.

Returns:

a list item for the passed data.

serializeDocumentReference

protected String serializeDocumentReference(WikiPageReference reference)

Serializes a document reference to be displayed to the user.

Parameters:

reference - a document reference

Returns:

a user friendly string serialization of a document reference

getNewOptionListItem

protected ListItem<WikiPage> getNewOptionListItem()

Overrides:

getNewOptionListItem in class AbstractListSelectorWizardStep<EntityLink<LinkConfig>,WikiPage>

Returns:

an list item representation for a new item to add in the managed list, or null if no such item should be appended to the list.

getNextStep

public String getNextStep()

Specified by:

getNextStep in interface WizardStep

Overrides:

getNextStep in class AbstractNavigationAwareWizardStep

getWikiService

protected WikiServiceAsync getWikiService()

Returns:

the service used to fetch the lists of pages