EDIT

<stringAttribute key="org.eclipse.jdt.launching.VM_ARGUMENTS" value="-Dlog4j.configDebug=false&#10;-Dlog4j.configuration=file:///${system_property:user.home}/.cdmLibrary/log4j.properties&#10;&#10;-Dcdm.forceSchemaUpdate=true&#10;&#10;-Dcdm-vaadin.login.usr=admin&#10;-Dcdm-vaadin.login.pwd=00000"/>

import eu.etaxonomy.cdm.vaadin.view.registration.RegistrationWorkflowViewBean;

                    RegistrationWorkflowViewBean.NAME,

/**

* Copyright (C) 2017 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.vaadin.view.registration;

import java.util.ArrayList;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.context.event.EventListener;

import org.springframework.security.core.Authentication;

import com.vaadin.server.SystemError;

import com.vaadin.spring.annotation.SpringComponent;

import com.vaadin.spring.annotation.ViewScope;

import eu.etaxonomy.cdm.api.service.INameService;

import eu.etaxonomy.cdm.api.service.IRegistrationService;

import eu.etaxonomy.cdm.model.common.User;

import eu.etaxonomy.cdm.model.name.Rank;

import eu.etaxonomy.cdm.model.name.Registration;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.model.name.TaxonNameFactory;

import eu.etaxonomy.cdm.model.name.TypeDesignationBase;

import eu.etaxonomy.cdm.model.reference.Reference;

import eu.etaxonomy.cdm.service.CdmFilterablePagingProvider;

import eu.etaxonomy.cdm.service.CdmStore;

import eu.etaxonomy.cdm.service.IRegistrationWorkingSetService;

import eu.etaxonomy.cdm.vaadin.event.EntityChangeEvent;

import eu.etaxonomy.cdm.vaadin.event.ReferenceEditorAction;

import eu.etaxonomy.cdm.vaadin.event.RegistrationEditorAction;

import eu.etaxonomy.cdm.vaadin.event.ShowDetailsEvent;

import eu.etaxonomy.cdm.vaadin.event.TaxonNameEditorAction;

import eu.etaxonomy.cdm.vaadin.event.TypeDesignationWorkingsetEditorAction;

import eu.etaxonomy.cdm.vaadin.event.registration.RegistrationWorkflowEvent;

import eu.etaxonomy.cdm.vaadin.model.registration.RegistrationWorkingSet;

import eu.etaxonomy.cdm.vaadin.util.CdmTitleCacheCaptionGenerator;

import eu.etaxonomy.cdm.vaadin.util.converter.TypeDesignationSetManager.TypeDesignationWorkingSetType;

import eu.etaxonomy.cdm.vaadin.view.name.SpecimenTypeDesignationWorkingsetPopupEditor;

import eu.etaxonomy.cdm.vaadin.view.name.TaxonNamePopupEditor;

import eu.etaxonomy.cdm.vaadin.view.name.TypeDesignationWorkingsetEditorIdSet;

import eu.etaxonomy.cdm.vaadin.view.reference.ReferencePopupEditor;

import eu.etaxonomy.vaadin.mvp.AbstractPresenter;

import eu.etaxonomy.vaadin.ui.view.DoneWithPopupEvent;

import eu.etaxonomy.vaadin.ui.view.DoneWithPopupEvent.Reason;

/**

 * @author a.kohlbecker

 * @since Mar 3, 2017

 *

 */

@SpringComponent

@ViewScope

public class RegistrationWorkflowPresenter extends AbstractPresenter<RegistrationWorkflowView> {

    private static final long serialVersionUID = 1L;

    @Autowired

    private IRegistrationWorkingSetService workingSetService;

    /**

     * @return the workingSetService

     */

    public IRegistrationWorkingSetService getWorkingSetService() {

        ensureBoundConversation();

        return workingSetService;

    }

    private RegistrationWorkingSet workingset;

    private TaxonName newTaxonNameForRegistration = null;

    private RegistrationDTO newRegistrationDTOWithExistingName;

    /**

     *

     */

    public RegistrationWorkflowPresenter() {

    }

    /**

     * Always create a new Store

     *

     * @return

     */

    protected CdmStore<Registration, IRegistrationService> getRegistrationStore(){

        return new CdmStore<Registration, IRegistrationService>(getRepo(), getRepo().getRegistrationService());

    }

    /**

     * Always create a new Store

     *

     * @return

     */

    protected CdmStore<TaxonName, INameService> getTaxonNameStore(){

        return new  CdmStore<TaxonName, INameService>(getRepo(), getRepo().getNameService());

    }

    /**

     * @param taxonNameId

     * @return

     */

    protected Registration createNewRegistrationForName(Integer taxonNameId) {

        // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        // move into RegistrationWorkflowStateMachine

        long identifier = System.currentTimeMillis();

        Registration reg = Registration.NewInstance(

                "http://phycobank.org/" + identifier,

                "" + identifier,

                taxonNameId != null ? getRepo().getNameService().find(taxonNameId) : null,

                null);

        Authentication authentication = currentSecurityContext().getAuthentication();

        reg.setSubmitter((User)authentication.getPrincipal());

        EntityChangeEvent event = getRegistrationStore().saveBean(reg);

        // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        return getRepo().getRegistrationService().find(event.getEntityId());

    }

    /**

     *

     */

    protected void refreshView() {

        getConversationHolder().getSession().clear();

        presentWorkingSet(workingset.getCitationId());

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void handleViewEntered() {

        super.handleViewEntered();

        presentWorkingSet(getView().getCitationID());

        CdmFilterablePagingProvider<TaxonName> pagingProvider = new CdmFilterablePagingProvider<TaxonName>(

                getRepo().getNameService(), this);

        CdmTitleCacheCaptionGenerator<TaxonName> titleCacheGenrator = new CdmTitleCacheCaptionGenerator<TaxonName>();

        getView().getAddExistingNameCombobox().setCaptionGenerator(titleCacheGenrator);

        getView().getAddExistingNameCombobox().loadFrom(pagingProvider, pagingProvider, pagingProvider.getPageSize());

    }

    /**

     * Loads the WorkingSet from the data base and passes it to the view.

     *

     * @param registrationID

     */

    private void presentWorkingSet(Integer referenceID) {

        try {

            workingset = getWorkingSetService().loadWorkingSetByReferenceID(referenceID);

        } catch (RegistrationValidationException error) {

            getView().getWorkflow().setComponentError(new SystemError(error));

        }

        if(workingset == null || workingset.getCitationId() == null){

            Reference citation = getRepo().getReferenceService().find(referenceID);

            workingset = new RegistrationWorkingSet(citation);

        }

        // getView().setHeaderText("Registrations for " + workingset.getCitation());

        getView().setWorkingset(workingset);

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).ADD && #event.sourceComponent == null")

    public void onReferenceEditorActionAdd(ReferenceEditorAction event) {

        ReferencePopupEditor popup = getNavigationManager().showInPopup(ReferencePopupEditor.class);

        popup.loadInEditor(null);

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).EDIT && #event.sourceComponent == null")

    public void onReferenceEditorActionEdit(ReferenceEditorAction event) {

        ReferencePopupEditor popup = getNavigationManager().showInPopup(ReferencePopupEditor.class);

        popup.withDeleteButton(true);

        popup.loadInEditor(event.getEntityId());

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).EDIT && #event.sourceComponent == null")

    public void onRegistrationEditorAction(RegistrationEditorAction event) {

        RegistrationPopupEditor popup = getNavigationManager().showInPopup(RegistrationPopupEditor.class);

        popup.loadInEditor(event.getEntityId());

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).EDIT && #event.sourceComponent == null")

    public void onTaxonNameEditorActionEdit(TaxonNameEditorAction event) {

        TaxonNamePopupEditor popup = getNavigationManager().showInPopup(TaxonNamePopupEditor.class);

        popup.withDeleteButton(true);

        // disable NomReferenceCombobox:

        // the in the registration application inReferences should only edited centrally

        popup.getNomReferenceCombobox().setEnabled(false);

        popup.loadInEditor(event.getEntityId());

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).ADD")

    public void onTaxonNameEditorActionAdd(TaxonNameEditorAction event) {

        newTaxonNameForRegistration = TaxonNameFactory.NewBotanicalInstance(Rank.SPECIES());

        newTaxonNameForRegistration.setNomenclaturalReference(getRepo().getReferenceService().find(workingset.getCitationId()));

        EntityChangeEvent nameSaveEvent = getTaxonNameStore().saveBean(newTaxonNameForRegistration);

        newTaxonNameForRegistration = getRepo().getNameService().find(nameSaveEvent.getEntityId());

        TaxonNamePopupEditor popup = getNavigationManager().showInPopup(TaxonNamePopupEditor.class);

        popup.withDeleteButton(true);

        popup.loadInEditor(newTaxonNameForRegistration.getId());

        // disable NomReferenceCombobox:

        // the in the registration application inReferences should only edited centrally

        popup.getNomReferenceCombobox().setEnabled(false);

    }

    /**

     * Creates a new <code>Registration</code> for a new name that has just been edited

     * using the <code>TaxonNamePopupEditor</code>. The new name was previously created

     * in this presenter as <code>newTaxonNameForRegistration</code> (see {@link #onTaxonNameEditorActionAdd(TaxonNameEditorAction)})

     * and is either filled with data (<code>Reason.SAVE</code>) or it is still empty

     * (<code>Reason.CANCEL</code>).

     *

     *

     * @param event

     * @throws RegistrationValidationException

     */

    @EventListener

    public void onDoneWithTaxonnameEditor(DoneWithPopupEvent event) throws RegistrationValidationException{

        if(event.getPopup() instanceof TaxonNamePopupEditor){

            if(newTaxonNameForRegistration != null && event.getReason().equals(Reason.SAVE)){

                int taxonNameId = newTaxonNameForRegistration.getId();

                Registration reg = createNewRegistrationForName(taxonNameId);

                workingset.add(reg);

                refreshView();

            } else if(event.getReason().equals(Reason.CANCEL)){

                // clean up

                getTaxonNameStore().deleteBean(newTaxonNameForRegistration);

            }

            newTaxonNameForRegistration = null;

        }

    }

    /**

     * Creates a new Registration for an exiting (previously published name).

     *

     * @param event

     * @throws RegistrationValidationException

     */

    @EventListener(condition = "#event.action == T(eu.etaxonomy.cdm.vaadin.event.registration.RegistrationWorkflowEvent.Action).start")

    public void onRegistrationWorkflowEventActionStart(RegistrationWorkflowEvent event) throws RegistrationValidationException {

        getView().getAddExistingNameCombobox().commit();

        TaxonName typifiedName = getView().getAddExistingNameCombobox().getValue();

        if(typifiedName != null){

            Registration newRegistrationWithExistingName = createNewRegistrationForName(null);

            Reference citation = getRepo().getReferenceService().find(workingset.getCitationId());

            newRegistrationDTOWithExistingName = new RegistrationDTO(newRegistrationWithExistingName, typifiedName, citation);

            workingset.add(newRegistrationDTOWithExistingName);

            // tell the view to update the workingset

            getView().setWorkingset(workingset);

            getView().getAddExistingNameRegistrationButton().setEnabled(false);

            getView().getAddExistingNameRegistrationButton().setDescription("You first need to add a type designation to the previously created registration.");

        } else {

            logger.error("Seletced name is NULL");

        }

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).EDIT && #event.sourceComponent == null")

    public void onTypeDesignationsEditorActionEdit(TypeDesignationWorkingsetEditorAction event) {

            if(event.getWorkingSetType() == TypeDesignationWorkingSetType.SPECIMEN_TYPE_DESIGNATION_WORKINGSET ){

                SpecimenTypeDesignationWorkingsetPopupEditor popup = getNavigationManager().showInPopup(SpecimenTypeDesignationWorkingsetPopupEditor.class);

                popup.loadInEditor(new TypeDesignationWorkingsetEditorIdSet(event.getRegistrationId(), event.getEntityId()));

            } else {

                // TypeDesignationWorkingSetType.NAME_TYPE_DESIGNATION_WORKINGSET

                // FIXME implement NameTypeDesignationWorkingsetPopupEditor

            }

    }

    @EventListener(condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action).ADD && #event.sourceComponent == null")

    public void onAddNewTypeDesignationWorkingset(TypeDesignationWorkingsetEditorAction event) {

        if(event.getWorkingSetType() == TypeDesignationWorkingSetType.SPECIMEN_TYPE_DESIGNATION_WORKINGSET){

            SpecimenTypeDesignationWorkingsetPopupEditor popup = getNavigationManager().showInPopup(SpecimenTypeDesignationWorkingsetPopupEditor.class);

            TypeDesignationWorkingsetEditorIdSet identifierSet;

            Integer typifiedNameId;

            if(newRegistrationDTOWithExistingName != null){

                typifiedNameId = newRegistrationDTOWithExistingName.getTypifiedName().getId();

            } else {

                typifiedNameId = workingset.getRegistrationDTO(event.getRegistrationId())

                        .get()

                        .getTypifiedName()

                        .getId();

            }

            identifierSet = new TypeDesignationWorkingsetEditorIdSet(

                    event.getRegistrationId(),

                    getView().getCitationID(),

                    typifiedNameId

                    );

            popup.loadInEditor(identifierSet

                 );

            popup.withDeleteButton(true);

        } else {

            // TypeDesignationWorkingSetType.NAME_TYPE_DESIGNATION_WORKINGSET

            // FIXME implement NameTypeDesignationWorkingsetPopupEditor

        }

    }

    /**

     * Performs final actions after a TypeDesignationEditor which has been

     * opened to add a TypeDesignation to a Registration object which was

     * created for an previously published name. Prior adding a typedesignation,

     * the according Registration object is dangling, that has no association to

     * any entity denoting an nomenclatural act which has a reference to a

     * publication. This means that the registration object is not in the

     * working set.

     *

     *

     * @param event

     * @throws RegistrationValidationException

     */

    @EventListener

    public void onDoneWithTypeDesignationEditor(DoneWithPopupEvent event) throws RegistrationValidationException{

        if(event.getPopup() instanceof SpecimenTypeDesignationWorkingsetPopupEditor){

            if(event.getReason().equals(Reason.SAVE)){

                 refreshView();

            } else if(event.getReason().equals(Reason.CANCEL)){

                // clean up

                if(newRegistrationDTOWithExistingName != null){

                    getRegistrationStore().deleteBean(newRegistrationDTOWithExistingName.registration());

                }

            }

            // set newRegistrationDTOWithExistingName NULL in any case

            newRegistrationDTOWithExistingName = null;

        }

    }

    @EventListener(classes=ShowDetailsEvent.class, condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.model.registration.RegistrationWorkingSet)")

    public void onShowRegistrationWorkingSetMessages(ShowDetailsEvent<?,?> event) { // WARNING don't use more specific generic type arguments

        List<String> messages = new ArrayList<>();

        for(RegistrationDTO dto : workingset.getRegistrationDTOs()){

            dto.getMessages().forEach(m -> messages.add(dto.getSummary() + ": " + m));

        }

        if(event.getProperty().equals("messages")){

            getView().openDetailsPopup("Messages", messages);

        }

    }

    @EventListener(classes=ShowDetailsEvent.class, condition = "#event.type == T(eu.etaxonomy.cdm.vaadin.view.registration.RegistrationDTO)")

    public void onShowRegistrationMessages(ShowDetailsEvent<?,?> event) { // WARNING don't use more specific generic type arguments

        RegistrationDTO regDto = workingSetService.loadDtoById((Integer)event.getIdentifier());

        if(event.getProperty().equals("messages")){

            if(getView() != null){

                getView().openDetailsPopup("Messages", regDto.getMessages());

            }

        }

    }

    @EventListener

    public void onEntityChangeEvent(EntityChangeEvent event){

        if(workingset == null){

            return;

        }

        if(Reference.class.isAssignableFrom(event.getEntityType())){

            if(workingset.getCitationId().equals(event.getEntityId())){

                refreshView();

            }

        } else

        if(Registration.class.isAssignableFrom(event.getEntityType())){

            if(workingset.getRegistrations().stream().anyMatch(reg -> reg.getId() == event.getEntityId())){

                refreshView();

            }

        } else

        if(TaxonName.class.isAssignableFrom(event.getEntityType())){

            if(workingset.getRegistrationDTOs().stream().anyMatch(reg ->

                reg.getTypifiedName() != null

                && reg.getTypifiedName().getId() == event.getEntityId())){

                    refreshView();

            }

        } else

        if(TypeDesignationBase.class.isAssignableFrom(event.getEntityType())){

            if(workingset.getRegistrationDTOs().stream().anyMatch(

                    reg -> reg.getTypeDesignations().stream().anyMatch(

                            td -> td.getId() == event.getEntityId()

                            )

                        )

                    ){

                refreshView();

            }

        }

    }

}

/**

* Copyright (C) 2017 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.vaadin.view.registration;

import java.util.List;

import java.util.UUID;

import org.vaadin.viritin.fields.LazyComboBox;

import com.vaadin.ui.AbstractLayout;

import com.vaadin.ui.Button;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.vaadin.event.TypeDesignationWorkingsetEditorAction;

import eu.etaxonomy.cdm.vaadin.model.registration.RegistrationWorkingSet;

import eu.etaxonomy.vaadin.mvp.ApplicationView;

/**

 * @author a.kohlbecker

 * @since Mar 3, 2017

 *

 */

public interface RegistrationWorkflowView extends ApplicationView{

    public static final String ACTION_NEW = "new";

    public static final String ACTION_EDIT = "edit";

    AbstractLayout getWorkflow();

    /**

     * Open a popup editor for an existing TaxonName if the nameUuid is

     * given otherwise a blank editor will open if the  nameUuid is null.

     *

     * @param nameUuid can be null

     */

    void openNameEditor(UUID nameUuid);

    /**

     * Open a popup editor for an existing Reference if the referenceUuid is

     * given otherwise a blank editor will open if the  referenceUuid is null.

     *

     * @param referenceUuid can be null

     */

    void openReferenceEditor(UUID referenceUuid);

    /**

     * @param subheaderText

     */

    void setSubheaderText(String subheaderText);

    /**

     * @param subheaderText

     */

    void setHeaderText(String subheaderText);

    /**

     * @param workingset

     */

    void setWorkingset(RegistrationWorkingSet workingset);

    void addBlockingRegistration(RegistrationDTO blocking);

    /**

     * @param messages

     */

    void openDetailsPopup(String caption, List<String> messages);

    Button getAddNewNameRegistrationButton();

    /**

     * @return

     */

    Button getAddExistingNameRegistrationButton();

    public LazyComboBox<TaxonName> getAddExistingNameCombobox();

    Integer getCitationID();

    /**

     * selecting a type will cause a {@link TypeDesignationWorkingsetEditorAction} to be emitted.

     * On Cancel .. TODO

     * @param registrationEntityId

     */

    void chooseNewTypeRegistrationWorkingset(Integer registrationEntityId);

}

/**

* Copyright (C) 2017 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.vaadin.view.registration;

import java.util.ArrayList;

import java.util.Collection;

import java.util.List;

import java.util.UUID;

import org.springframework.security.core.GrantedAuthority;

import org.vaadin.viritin.fields.LazyComboBox;

import com.vaadin.navigator.View;

import com.vaadin.navigator.ViewChangeListener.ViewChangeEvent;

import com.vaadin.server.FontAwesome;

import com.vaadin.server.GenericFontIcon;

import com.vaadin.server.Page;

import com.vaadin.spring.annotation.SpringView;

import com.vaadin.ui.AbstractLayout;

import com.vaadin.ui.Alignment;

import com.vaadin.ui.Button;

import com.vaadin.ui.Component;

import com.vaadin.ui.CssLayout;

import com.vaadin.ui.GridLayout;

import com.vaadin.ui.HorizontalLayout;

import com.vaadin.ui.Label;

import com.vaadin.ui.Notification;

import com.vaadin.ui.Panel;

import com.vaadin.ui.TabSheet;

import com.vaadin.ui.TabSheet.Tab;

import com.vaadin.ui.UI;

import com.vaadin.ui.VerticalLayout;

import com.vaadin.ui.Window;

import com.vaadin.ui.themes.ValoTheme;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationItem;

import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationItemEditButtonGroup;

import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationItemEditButtonGroup.TypeDesignationWorkingSetButton;

import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationStateLabel;

import eu.etaxonomy.cdm.vaadin.component.registration.RegistrationStyles;

import eu.etaxonomy.cdm.vaadin.component.registration.WorkflowSteps;

import eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction;

import eu.etaxonomy.cdm.vaadin.event.AbstractEditorAction.Action;

import eu.etaxonomy.cdm.vaadin.event.ReferenceEditorAction;

import eu.etaxonomy.cdm.vaadin.event.RegistrationEditorAction;

import eu.etaxonomy.cdm.vaadin.event.ShowDetailsEvent;

import eu.etaxonomy.cdm.vaadin.event.TaxonNameEditorAction;

import eu.etaxonomy.cdm.vaadin.event.TypeDesignationWorkingsetEditorAction;

import eu.etaxonomy.cdm.vaadin.event.registration.RegistrationWorkflowEvent;

import eu.etaxonomy.cdm.vaadin.model.registration.RegistrationWorkingSet;

import eu.etaxonomy.cdm.vaadin.model.registration.WorkflowStep;

import eu.etaxonomy.cdm.vaadin.security.AccessRestrictedView;

import eu.etaxonomy.cdm.vaadin.security.UserHelper;

import eu.etaxonomy.cdm.vaadin.util.converter.TypeDesignationSetManager.TypeDesignationWorkingSetType;

import eu.etaxonomy.cdm.vaadin.view.AbstractPageView;

/**

 * @author a.kohlbecker

 * @since Mar 2, 2017

 *

 */

@SpringView(name=RegistrationWorkflowViewBean.NAME)

public class RegistrationWorkflowViewBean extends AbstractPageView<RegistrationWorkflowPresenter>

    implements RegistrationWorkflowView, View, AccessRestrictedView {

    public static final String DOM_ID_WORKINGSET = "workingset";

    private static final long serialVersionUID = -213040114015958970L;

    public static final String NAME = "workflow";

    private static final boolean REG_ITEM_AS_BUTTON_GROUP = true;

    public RegistrationType regType = null;

    private List<CssLayout> registrations = new ArrayList<>();

    private String headerText = "Registration Workingset Editor";

    private String subheaderText = "";

    private boolean addNameAndTypeEditButtons = false;

    private Integer citationID;

    private Button addNewNameRegistrationButton;

    private LazyComboBox<TaxonName> existingNameCombobox;

    private GridLayout registrationsGrid;

    private Button addExistingNameButton;

    private RegistrationItem workingsetHeader;

    private Panel registrationListPanel;

    public RegistrationWorkflowViewBean() {

        super();

    }

    /**

     * {@inheritDoc}

     */

    @Override

    protected void initContent() {

        getLayout().setId(NAME);

        updateHeader();

        // all content is added in createRegistrationsList()

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void enter(ViewChangeEvent event) {

        if(event.getParameters() != null){

            this.citationID = Integer.valueOf(event.getParameters());

            getPresenter().handleViewEntered();

        }

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void setWorkingset(RegistrationWorkingSet workingset) {

        if(workingsetHeader != null){

            getLayout().removeComponent(workingsetHeader);

            getLayout().removeComponent(registrationListPanel);

        }

        registrationListPanel = createRegistrationsList(workingset);

        registrationListPanel.setStyleName("registration-list");

        registrationListPanel.setCaption("Registrations");

        workingsetHeader = new RegistrationItem(workingset, this);

        if(UserHelper.fromSession().userIsRegistrationCurator() || UserHelper.fromSession().userIsAdmin()){

            workingsetHeader.getSubmitterLabel().setVisible(true);

        }

        addContentComponent(workingsetHeader, null);

        addContentComponent(registrationListPanel, 1.0f);

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void addBlockingRegistration(RegistrationDTO blocking) {

        if(registrations == null) {

            throw new RuntimeException("A Workingset must be present prior adding blocking registrations.");

        }

        // add the blocking registration

    }

    private Component createWorkflowTabSheet(RegistrationWorkingSet workingset, Component namesTypesPanel){

        if(namesTypesPanel == null){

            namesTypesPanel = new CssLayout();

        }

        Component citationComponent = new CssLayout(); // new Label(workingset.getCitation());

        Component curationComponent = new CssLayout(); // new Label("Curation in progress ...")

        Component releaseComponent = new CssLayout(); // new Label("Not yet published")

        GenericFontIcon tabIcon = new GenericFontIcon("IcoMoon", 0xe900);

        TabSheet tabsheet = new TabSheet();

        // tabsheet.addStyleName(ValoTheme.TABSHEET_FRAMED);

        //tabsheet.addStyleName(ValoTheme.TABSHEET_PADDED_TABBAR);

        tabsheet.addStyleName("workflow-tabsheet");

        Tab pubDetailsTab = tabsheet.addTab(citationComponent, WorkflowStep.PUBLICATION_DETAILS.getRepresentation(), tabIcon);

        Tab namesTypesTab = tabsheet.addTab(namesTypesPanel, WorkflowStep.NAMES_N_TYPES.getRepresentation(), tabIcon);

        Tab curationTab = tabsheet.addTab(curationComponent, WorkflowStep.CURATION.getRepresentation(), tabIcon);

        Tab awaitingPubTab = tabsheet.addTab(releaseComponent, WorkflowStep.AWAITING_PUBLICATION.getRepresentation(), tabIcon);

        pubDetailsTab.setStyleName("bg-status-" + WorkflowStep.PUBLICATION_DETAILS.name());

        namesTypesTab.setStyleName("bg-status-" + WorkflowStep.NAMES_N_TYPES.name());

        curationTab.setStyleName("bg-status-" + WorkflowStep.CURATION.name());

        awaitingPubTab.setStyleName("bg-status-" + WorkflowStep.AWAITING_PUBLICATION.name());

        return tabsheet;

    }

    /**

     * @param workingset

     * @return

     */

    public Panel createRegistrationsList(RegistrationWorkingSet workingset) {

        registrationsGrid = new GridLayout(3, 1);

        registrationsGrid.setWidth("100%");

        // allow vertical scrolling:

        registrationsGrid.setHeightUndefined();

        //registrationsGrid.setColumnExpandRatio(0, 0.1f);

        registrationsGrid.setColumnExpandRatio(1, 1f);

        int row = 0;

        for(RegistrationDTO dto : workingset.getRegistrationDTOs()) {

            putRegistrationListComponent(registrationsGrid, row++, dto);

        }

        Label addRegistrationLabel_1 = new Label("Add a new registration for a");

        Label addRegistrationLabel_2 = new Label("or an");

        addNewNameRegistrationButton = new Button("new name");

        addNewNameRegistrationButton.setDescription("A name which is newly published in this publication.");

        addNewNameRegistrationButton.addClickListener(

                e -> eventBus.publishEvent(new TaxonNameEditorAction(Action.ADD, addNewNameRegistrationButton))

                );

        addExistingNameButton = new Button("existing name:");

        addExistingNameButton.setDescription("A name which was previously published in a earlier publication.");

        addExistingNameButton.setEnabled(false);

        addExistingNameButton.addClickListener(

                e -> eventBus.publishEvent(new RegistrationWorkflowEvent(citationID, RegistrationWorkflowEvent.Action.start))

                );

        existingNameCombobox = new LazyComboBox<TaxonName>(TaxonName.class);

        existingNameCombobox.addValueChangeListener(

                e -> addExistingNameButton.setEnabled(e.getProperty().getValue() != null)

                );

        HorizontalLayout buttonContainer = new HorizontalLayout(addRegistrationLabel_1, addNewNameRegistrationButton, addRegistrationLabel_2, addExistingNameButton, existingNameCombobox);

        buttonContainer.setSpacing(true);

//        buttonContainer.setWidth(100, Unit.PERCENTAGE);

        buttonContainer.setComponentAlignment(addRegistrationLabel_1, Alignment.MIDDLE_LEFT);

        buttonContainer.setComponentAlignment(addRegistrationLabel_2, Alignment.MIDDLE_LEFT);

        registrationsGrid.addComponent(buttonContainer, 0, row, 2, row);

        registrationsGrid.setComponentAlignment(buttonContainer, Alignment.MIDDLE_RIGHT);

        Panel namesTypesPanel = new Panel(registrationsGrid);

        namesTypesPanel.setSizeFull();

        return namesTypesPanel;

    }

    /**

     * @param grid

     * @param row If null, the new row will be inserted as last registration item, that is before the button row.

     * @param dto

     */

    protected void putRegistrationListComponent(GridLayout grid, int row, RegistrationDTO dto) {

        grid.setRows(grid.getRows() + 1);

        CssLayout buttonGroup = new CssLayout();

        buttonGroup.setStyleName(ValoTheme.LAYOUT_COMPONENT_GROUP);

        Button messageButton = new Button(FontAwesome.COMMENT);

        messageButton.setStyleName(ValoTheme.BUTTON_TINY); //  + " " + RegistrationStyles.STYLE_FRIENDLY_FOREGROUND);

        if(dto.getMessages().isEmpty()){

            messageButton.setEnabled(false);

        } else {

            messageButton.addClickListener(e -> eventBus.publishEvent(

                    new ShowDetailsEvent<RegistrationDTO, Integer>(

                        e,

                        RegistrationDTO.class,

                        dto.getId(),

                        "messages"

                        )

                    )

                );

        }

        messageButton.setCaption("<span class=\"" + RegistrationStyles.BUTTON_BADGE +"\"> " + dto.getMessages().size() + "</span>");

        messageButton.setCaptionAsHtml(true);

        buttonGroup.addComponent(messageButton);

        RegistrationStateLabel stateLabel = new RegistrationStateLabel().update(dto.getStatus());

        if(UserHelper.fromSession().userIsRegistrationCurator() || UserHelper.fromSession().userIsAdmin()) {

            Button editRegistrationButton = new Button(FontAwesome.COG);

            editRegistrationButton.setStyleName(ValoTheme.BUTTON_TINY);

            editRegistrationButton.setDescription("Edit registration");

            editRegistrationButton.addClickListener(e -> getEventBus().publishEvent(new RegistrationEditorAction(

                AbstractEditorAction.Action.EDIT,

                dto.getId(),

                null,

                this

                )));

            buttonGroup.addComponent(editRegistrationButton);

        }

        if(addNameAndTypeEditButtons ){

            Button editNameButton = new Button(FontAwesome.TAG);

            editNameButton.setStyleName(ValoTheme.BUTTON_TINY);

            editNameButton.setDescription("Edit name");

            if(dto.getName() != null){

                editNameButton.addClickListener(e -> {

                        Integer nameId = dto.getName().getId();

                        getEventBus().publishEvent(new TaxonNameEditorAction(

                            AbstractEditorAction.Action.EDIT,

                            nameId

                            )

                        );

                    });

            } else {

                editNameButton.setEnabled(false);

            }

            Button editTypesButton = new Button(FontAwesome.LEAF);

            editTypesButton.setStyleName(ValoTheme.BUTTON_TINY);

            editTypesButton.setDescription("Edit type designations");

            if(dto.getOrderdTypeDesignationWorkingSets() != null && !dto.getOrderdTypeDesignationWorkingSets().isEmpty()){

//                editTypesButton.addClickListener(e -> {

//                    int regId = dto.getId();

//                        getEventBus().publishEvent(new TypeDesignationSetEditorAction(

//                            AbstractEditorAction.Action.EDIT,

//                            regId

//                            )

//                        );

//                    });

            } else {

                editTypesButton.setEnabled(false);

            }

            buttonGroup.addComponents(editNameButton, editTypesButton);

        }

        Component regItem;

        if(REG_ITEM_AS_BUTTON_GROUP){

            RegistrationItemEditButtonGroup editButtonGroup = new RegistrationItemEditButtonGroup(dto);

            if(editButtonGroup.getNameButton() != null){

                editButtonGroup.getNameButton().getButton().addClickListener(e -> {

                    Integer nameId = editButtonGroup.getNameButton().getId();

                    getEventBus().publishEvent(new TaxonNameEditorAction(

                        AbstractEditorAction.Action.EDIT,

                        nameId,

                        null, //e.getButton(), the listener method expects this to be null

                        this

                        )

                    );

                });

            }

            for(TypeDesignationWorkingSetButton workingsetButton : editButtonGroup.getTypeDesignationButtons()){

                workingsetButton.getButton().addClickListener(e -> {

                    Integer typeDesignationWorkingsetId = workingsetButton.getId();

                    TypeDesignationWorkingSetType workingsetType = workingsetButton.getType();

                    Integer registrationEntityID = dto.getId();

                    getEventBus().publishEvent(new TypeDesignationWorkingsetEditorAction(

                            AbstractEditorAction.Action.EDIT,

                            typeDesignationWorkingsetId,

                            workingsetType,

                            registrationEntityID,

                            null, //e.getButton(), the listener method expects this to be null

                            this

                            )

                        );

                });

            }

            editButtonGroup.getAddTypeDesignationButton().addClickListener(

                    e -> chooseNewTypeRegistrationWorkingset(dto.getId())

                    );

            regItem = editButtonGroup;

        } else {

            regItem = new Label(dto.getSummary());

        }

        grid.addComponent(stateLabel, 0, row);

        grid.setComponentAlignment(stateLabel, Alignment.TOP_LEFT);

        grid.addComponent(regItem, 1, row);

        grid.addComponent(buttonGroup, 2, row);

        grid.setComponentAlignment(buttonGroup, Alignment.TOP_LEFT);

    }

    /**

     * @param button

     * @param registrationEntityId

     *

     */

    @Override

    public void chooseNewTypeRegistrationWorkingset(Integer registrationEntityId) {

        Window typeDesignationTypeCooser = new Window();

        typeDesignationTypeCooser.setModal(true);

        typeDesignationTypeCooser.setResizable(false);

        typeDesignationTypeCooser.setCaption("Add new type designation");

        Label label = new Label("Please select kind of type designation to be created.");

        Button newSpecimenTypeDesignationButton = new Button("Specimen type designation",

                e -> addNewTypeDesignationWorkingset(TypeDesignationWorkingSetType.SPECIMEN_TYPE_DESIGNATION_WORKINGSET, registrationEntityId, typeDesignationTypeCooser));

        Button newNameTypeDesignationButton = new Button("Name type designation",

                e -> addNewTypeDesignationWorkingset(TypeDesignationWorkingSetType.NAME_TYPE_DESIGNATION_WORKINGSET, registrationEntityId, typeDesignationTypeCooser));

        newNameTypeDesignationButton.setEnabled(false);

        VerticalLayout layout = new VerticalLayout(label, newSpecimenTypeDesignationButton, newNameTypeDesignationButton);

        layout.setMargin(true);

        layout.setSpacing(true);

        layout.setComponentAlignment(newSpecimenTypeDesignationButton, Alignment.MIDDLE_CENTER);

        layout.setComponentAlignment(newNameTypeDesignationButton, Alignment.MIDDLE_CENTER);

        typeDesignationTypeCooser.setContent(layout);

        UI.getCurrent().addWindow(typeDesignationTypeCooser);

    }

    /**

     * @param button

     *

     */

    protected void addNewTypeDesignationWorkingset(TypeDesignationWorkingSetType newWorkingsetType, Integer registrationEntityId, Window typeDesignationTypeCooser) {

        UI.getCurrent().removeWindow(typeDesignationTypeCooser);

        getEventBus().publishEvent(new TypeDesignationWorkingsetEditorAction(

                AbstractEditorAction.Action.ADD,

                newWorkingsetType,

                registrationEntityId,

                null,

                this

                ));

    }

    /**

    *

    */

   private void addBulletWorkflowName() {

       WorkflowSteps steps = new WorkflowSteps();

       steps.appendNewWorkflowItem(1, "Publication details including the publisher.",

               e -> eventBus.publishEvent(new ReferenceEditorAction(Action.EDIT)));

       steps.appendNewWorkflowItem(2, "One or multiple published scientific new names.",

               e -> eventBus.publishEvent(new TaxonNameEditorAction(Action.EDIT)));

       steps.appendNewWorkflowItem(3, "Request for data curation and await approval.", null);

       steps.appendNewWorkflowItem(4, "Awaiting publication", null);

       getWorkflow().addComponent(steps);

   }

   /**

   *

   */

  private void addBulletWorkflowTypification() {

      WorkflowSteps steps = new WorkflowSteps();

      steps.appendNewWorkflowItem(1, "Publication details including the publisher.",

              e -> eventBus.publishEvent(new ReferenceEditorAction(Action.EDIT)));

      steps.appendNewWorkflowItem(2, "One or multiple published typifications.",

              e -> eventBus.publishEvent(new TaxonNameEditorAction(Action.EDIT)));

      steps.appendNewWorkflowItem(3, "Request for data curation and await approval.", null);

      steps.appendNewWorkflowItem(4, "Awaiting publication", null);

      getWorkflow().addComponent(steps);

  }

    /**

     * {@inheritDoc}

     */

    @Override

    public void openReferenceEditor(UUID referenceUuid) {

        // TODO Auto-generated method stub

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void openNameEditor(UUID nameUuid) {

        // TODO Auto-generated method stub

    }

    /**

     * {@inheritDoc}

     */

    @Override

    protected String getHeaderText() {

        return headerText;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void setHeaderText(String text) {

        this.headerText = text;

        updateHeader();

    }

    /**

     * @return the subheaderText

     */

    public String getSubheaderText() {

        return subheaderText;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void setSubheaderText(String text) {

        subheaderText = text;

        updateHeader();

    }

    /**

     * {@inheritDoc}

     */

    @Override

    protected String getSubHeaderText() {

        return subheaderText;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public AbstractLayout getWorkflow() {

        return getLayout();

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public void openDetailsPopup(String caption, List<String> messages) {

        StringBuffer sb = new StringBuffer();

        sb.append("<div class=\"details-popup-content\">");

        messages.forEach(s -> sb.append(s).append("</br>"));

        sb.append("</div>");

        new Notification(caption, sb.toString(), Notification.Type.HUMANIZED_MESSAGE, true).show(Page.getCurrent());

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public boolean allowAnonymousAccess() {

        return false;

    }

    /**

     * {@inheritDoc}

     */

    @Override

    public Collection<Collection<GrantedAuthority>> allowedGrantedAuthorities() {

        return null;

    }

    /**

     * @return the addNewNameRegistrationButton

     */

    @Override

    public Button getAddNewNameRegistrationButton() {

        return addNewNameRegistrationButton;

    }

    @Override

    public Button getAddExistingNameRegistrationButton() {

        return addExistingNameButton;

    }

    @Override

    public LazyComboBox<TaxonName> getAddExistingNameCombobox() {

        return existingNameCombobox;

    }

    /**

     * @return the citationID

     */

    @Override

    public Integer getCitationID() {

        return citationID;

    }

}