org.xwiki.gwt.wysiwyg.client.widget.wizard.util
Class AbstractEntityListSelectorWizardStep<C extends EntityConfig,E extends Entity>

java.lang.Object
  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<C,E>

Type Parameters:

C - the type of entity configuration data associated with the link

E - the type of entity that is being selected

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:

AbstractPageListSelectorWizardStep, CurrentPageAttachmentSelectorWizardStep, CurrentPageImageSelectorWizardStep

public abstract class AbstractEntityListSelectorWizardStep<C extends EntityConfig,E extends Entity>
extends AbstractListSelectorWizardStep<EntityLink<C>,E>

Wizard step that allows the user to select an entity from a list.

Version:

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

Constructor Summary

AbstractEntityListSelectorWizardStep(WikiServiceAsync wikiService)
Creates a new entity selector that allows the user to select the entity to link to from a list.

Method Summary

WikiServiceAsync	getWikiService()
protected boolean	isSelectedByDefault(E listItemData)
protected void	saveSelectedValue(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> async) Saves the current selection in this panel in the data managed by this wizard step, if all validation goes well on the submit time.

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

addNavigationListener, display, displayError, fetchData, fillList, getErrorLabel, getList, getListItem, getMainPanel, getNewOptionListItem, getSelectedItem, getSelectErrorMessage, getSelectHelpLabel, hideError, init, onCancel, onDoubleClick, onKeyUp, onSubmit, refreshList, removeNavigationListener, setActive, setNewOptionOnTop

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

getData, getDirectionName, getResult, getValidDirections, initializeSelection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.gwt.user.client.ui.wizard.WizardStep

getNextStep, getStepTitle

Constructor Detail

AbstractEntityListSelectorWizardStep

public AbstractEntityListSelectorWizardStep(WikiServiceAsync wikiService)

Creates a new entity selector that allows the user to select the entity to link to from a list.

Parameters:

wikiService - the service used to serialize entity references

Method Detail

isSelectedByDefault

protected boolean isSelectedByDefault(E listItemData)

Overrides:

isSelectedByDefault in class AbstractListSelectorWizardStep<EntityLink<C extends EntityConfig>,E extends Entity>

Parameters:

listItemData - a list item data

Returns:

true of the list item with the given data should be selected by default, false otherwise

See Also:

AbstractListSelectorWizardStep.isSelectedByDefault(Object)

saveSelectedValue

protected void saveSelectedValue(com.google.gwt.user.client.rpc.AsyncCallback<java.lang.Boolean> async)

Saves the current selection in this panel in the data managed by this wizard step, if all validation goes well on the submit time.

Specified by:

saveSelectedValue in class AbstractListSelectorWizardStep<EntityLink<C extends EntityConfig>,E extends Entity>

Parameters:

async - the object to be notified after the selected value is saved

See Also:

AbstractListSelectorWizardStep.saveSelectedValue(AsyncCallback)

getWikiService

public WikiServiceAsync getWikiService()

Returns:

the service used to serialize entity references