Attachment #199726 for bug #350359

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

View | Details | Raw Unified | Return to bug 350359
Collapse All | Expand All

Lines 35-41 Service-Component: OSGI-INF/ExtensionServiceReview.xml, Link Here

(-)a/org.eclipse.skalli.model.ext.misc/META-INF/MANIFEST.MF (-1 / +2 lines)
35	OSGI-INF/ExtensionServiceLinkGroups.xml,	35	OSGI-INF/ExtensionServiceLinkGroups.xml,
36	OSGI-INF/MailingListMappingConfigSection.xml,	36	OSGI-INF/MailingListMappingConfigSection.xml,
37	OSGI-INF/ScmLocationMappingConfigSection.xml,	37	OSGI-INF/ScmLocationMappingConfigSection.xml,
38	OSGI-INF/ScrumPeopleProvider.xml	38	OSGI-INF/ScrumPeopleProvider.xml,
		39	OSGI-INF/ExtensionServiceRelatedProjects.xml
39	Export-Package: org.eclipse.skalli.model.ext.devinf,	40	Export-Package: org.eclipse.skalli.model.ext.devinf,
40	org.eclipse.skalli.model.ext.info,	41	org.eclipse.skalli.model.ext.info,
41	org.eclipse.skalli.model.ext.linkgroups,	42	org.eclipse.skalli.model.ext.linkgroups,




<?xml version="1.0" encoding="UTF-8"?><!--
    Copyright (c) 2010, 2011 SAP AG and others.
    All rights reserved. This program and the accompanying materials
    are made available under the terms of the Eclipse Public License v1.0
    which accompanies this distribution, and is available at
    http://www.eclipse.org/legal/epl-v10.html
   
    Contributors:
        SAP AG - initial API and implementation
 -->

<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="org.eclipse.skalli.model.ext.related">
   <implementation class="org.eclipse.skalli.model.ext.misc.internal.ExtensionServiceRelatedProjects"/>
   <service>
      <provide interface="org.eclipse.skalli.model.ext.ExtensionService"/>
   </service>
</scr:component>





/*******************************************************************************
 * Copyright (c) 2010, 2011 SAP AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     SAP AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.skalli.model.ext.misc;

import org.eclipse.skalli.common.util.UUIDList;
import org.eclipse.skalli.model.ext.ExtensionEntityBase;
import org.eclipse.skalli.model.ext.PropertyName;

public class RelatedProjectsExt extends ExtensionEntityBase {
    public static final String MODEL_VERSION = "1.0"; //$NON-NLS-1$
    public static final String NAMESPACE = "http://www.eclipse.org/skalli/2010/Model/Extension-Related"; //$NON-NLS-1$

    @PropertyName(position = 0)
    public static final String PROPERTY_CALCULATED = "calculated";

    @PropertyName(position = 1)
    public static final String PROPERTY_RELATED_PROJECT = "relatedProjects"; //$NON-NLS-1$

    private UUIDList relatedProjects;
    private boolean calculated;

    public boolean getCalculated() {
        return calculated;
    }

    public void setCalculated(boolean calculated) {
        this.calculated = calculated;
    }

    public UUIDList getRelatedProjects() {
        if (relatedProjects == null) {
            relatedProjects = new UUIDList();
        }
        return relatedProjects;
    }

    public void setRelatedProjects(UUIDList relatedProjects) {
        this.relatedProjects = new UUIDList(relatedProjects);
    }

}




/*******************************************************************************
 * Copyright (c) 2010, 2011 SAP AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     SAP AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.skalli.model.ext.misc.internal;

import java.util.Map;

import org.eclipse.skalli.common.util.CollectionUtils;
import org.eclipse.skalli.model.ext.ExtensionService;
import org.eclipse.skalli.model.ext.ExtensionServiceBase;
import org.eclipse.skalli.model.ext.misc.RelatedProjectsExt;

public class ExtensionServiceRelatedProjects extends ExtensionServiceBase<RelatedProjectsExt>
        implements ExtensionService<RelatedProjectsExt> {

    private static final String DESCRIPTION = "Information about projects that might be related to this projects or could also be of interest.";

    private static final String CAPTION = "Related Projects";

    private static final Map<String, String> CAPTIONS = CollectionUtils
            .asMap(new String[][] {
                    { RelatedProjectsExt.PROPERTY_RELATED_PROJECT, "Related Project" },
                    { RelatedProjectsExt.PROPERTY_CALCULATED,
                            "Calculate Related Projects (based on similarities to this project)" } });

    @Override
    public Class<RelatedProjectsExt> getExtensionClass() {
        return RelatedProjectsExt.class;
    }

    @Override
    public String getModelVersion() {
        return RelatedProjectsExt.MODEL_VERSION;
    }

    @Override
    public String getShortName() {
        return "relatedProjects";
    }

    @Override
    public String getCaption() {
        return CAPTION;
    }

    @Override
    public String getCaption(String propertyName) {
        String caption = CAPTIONS.get(propertyName);
        if (caption == null) {
            caption = super.getCaption(propertyName);
        }
        return caption;
    }

    @Override
    public String getDescription() {
        return DESCRIPTION;
    }

    @Override
    public String getNamespace() {
        return RelatedProjectsExt.NAMESPACE;
    }

    @Override
    public String getXsdFileName() {
        return null;
    }

}

Lines 41-46 Service-Component: OSGI-INF/ExtensionServiceProjectBasicsEditForm.xml, Link Here

(-)a/org.eclipse.skalli.view.ext.impl/META-INF/MANIFEST.MF (+1 lines)
41	OSGI-INF/ExtensionServiceMavenProjectExtEditForm.xml,	41	OSGI-INF/ExtensionServiceMavenProjectExtEditForm.xml,
42	OSGI-INF/ExtensionServiceReviewProjectExtEditForm.xml,	42	OSGI-INF/ExtensionServiceReviewProjectExtEditForm.xml,
43	OSGI-INF/ExtensionServiceScrumProjectExtEditForm.xml,	43	OSGI-INF/ExtensionServiceScrumProjectExtEditForm.xml,
		44	OSGI-INF/ExtensionServiceRelatedProjectsExtEditForm.xml,
44	OSGI-INF/ExtensionServiceProjectAboutBox.xml,	45	OSGI-INF/ExtensionServiceProjectAboutBox.xml,
45	OSGI-INF/ExtensionServiceProjectDevInfBox.xml,	46	OSGI-INF/ExtensionServiceProjectDevInfBox.xml,
46	OSGI-INF/ExtensionServiceProjectIssuesBox.xml,	47	OSGI-INF/ExtensionServiceProjectIssuesBox.xml,




<?xml version="1.0" encoding="UTF-8"?>
<!--
    Copyright (c) 2010, 2011 SAP AG and others.
    All rights reserved. This program and the accompanying materials
    are made available under the terms of the Eclipse Public License v1.0
    which accompanies this distribution, and is available at
    http://www.eclipse.org/legal/epl-v10.html
   
    Contributors:
        SAP AG - initial API and implementation
 -->

<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="org.eclipse.skalli.view.ext.impl.internal.forms.related">
   <implementation class="org.eclipse.skalli.view.ext.impl.internal.forms.RelatedProjectsExtEditForm"/>
   <service>
      <provide interface="org.eclipse.skalli.view.ext.ExtensionFormService"/>
   </service>
</scr:component>





/*******************************************************************************
 * Copyright (c) 2010, 2011 SAP AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     SAP AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.skalli.view.ext.impl.internal.forms;

import org.eclipse.skalli.common.util.UUIDList;
import org.eclipse.skalli.model.core.Project;
import org.eclipse.skalli.model.ext.misc.RelatedProjectsExt;
import org.eclipse.skalli.view.component.MultiComboBox;
import org.eclipse.skalli.view.ext.AbstractExtensionFormService;
import org.eclipse.skalli.view.ext.DefaultProjectFieldFactory;
import org.eclipse.skalli.view.ext.ProjectEditContext;

import com.vaadin.data.Item;
import com.vaadin.data.Property.ValueChangeListener;
import com.vaadin.data.util.BeanItem;
import com.vaadin.ui.CheckBox;
import com.vaadin.ui.Field;
import com.vaadin.ui.FormFieldFactory;

public class RelatedProjectsExtEditForm extends AbstractExtensionFormService<RelatedProjectsExt> {

    @Override
    public String getIconPath() {
        return "res/icons/relProjects.png"; //$NON-NLS-1$
    }

    @Override
    public float getRank() {
        return 1.5f;
    }

    @Override
    protected FormFieldFactory getFieldFactory(Project project, ProjectEditContext context) {
        return new FieldFactory(project, context);
    }

    @Override
    protected Item getItemDataSource(Project project) {
        return new BeanItem<RelatedProjectsExt>(getExtension(project));
    }

    private class FieldFactory extends DefaultProjectFieldFactory<RelatedProjectsExt> {

        private static final long serialVersionUID = 939519704283769367L;
        private RelatedProjectsExt extension;
        private Field comboBox;

        public FieldFactory(Project project, ProjectEditContext context) {
            super(project, RelatedProjectsExt.class, context);
            this.extension = getExtension(project);
        }

        @Override
        protected Field createField(Object propertyId, String caption) {

            if (RelatedProjectsExt.PROPERTY_CALCULATED.equals(propertyId)) {
                final CheckBox field = new CheckBox(caption);
                field.setImmediate(true);
                field.addListener(new ValueChangeListener() {

                    private static final long serialVersionUID = 3996507266934851419L;

                    @Override
                    public void valueChange(com.vaadin.data.Property.ValueChangeEvent event) {
                        if (comboBox != null) {
                            comboBox.setEnabled(!field.booleanValue());
                        }
                    }
                });
                return field;
            } else if (RelatedProjectsExt.PROPERTY_RELATED_PROJECT.equals(propertyId)) {
                UUIDList ids = extension.getRelatedProjects();
                comboBox = new MultiComboBox(caption, ids);
                comboBox.setEnabled(!extension.getCalculated());
                return comboBox;
            }
            return null;
        }
    }

    @Override
    public Class<RelatedProjectsExt> getExtensionClass() {
        return RelatedProjectsExt.class;
    }

    @Override
    public RelatedProjectsExt newExtensionInstance() {
        return new RelatedProjectsExt();
    }
}




 *******************************************************************************/
package org.eclipse.skalli.view.ext.impl.internal.infobox;

import java.util.UUID;

import org.eclipse.skalli.api.java.ProjectService;
import org.eclipse.skalli.api.java.SearchHit;
import org.eclipse.skalli.api.java.SearchResult;
import org.eclipse.skalli.api.java.SearchService;
import org.eclipse.skalli.common.Services;
import org.eclipse.skalli.common.util.UUIDList;
import org.eclipse.skalli.model.core.Project;
import org.eclipse.skalli.model.ext.misc.RelatedProjectsExt;
import org.eclipse.skalli.view.ext.AbstractInfoBox;
import org.eclipse.skalli.view.ext.ExtensionUtil;
import org.eclipse.skalli.view.ext.ProjectInfoBox;

import com.vaadin.terminal.ExternalResource;
import com.vaadin.ui.Component;
import com.vaadin.ui.CssLayout;
import com.vaadin.ui.Label;
import com.vaadin.ui.Layout;
import com.vaadin.ui.Link;

public class RelatedProjectsInfoBox extends AbstractInfoBox implements ProjectInfoBox {


        Layout layout = new CssLayout();
        layout.setSizeFull();

        RelatedProjectsExt ext = project.getExtension(RelatedProjectsExt.class);
        if (ext != null) {
            Label label = new Label("The following projects might also be of interest to you:",
                    Label.CONTENT_XHTML);
            layout.addComponent(label);
            boolean calculated = ext.getCalculated();
            if (calculated) {
                addCalculatedContent(project, layout);
            } else {
                UUIDList ids = ext.getRelatedProjects();
                ProjectService projectService = Services.getRequiredService(ProjectService.class);
                for (UUID uuid : ids) {
                    Project relatedProject = projectService.getByUUID(uuid);
                    ExternalResource externalResource = new ExternalResource("/projects/" + relatedProject.getProjectId());
                    String content = HSPACE + "<a href=" + externalResource.getURL() + ">" + relatedProject.getName()
                            + "</a>";
                    Label l = new Label(content, Label.CONTENT_XHTML);
                    layout.addComponent(l);
                }
            }
        }
        return layout;
    }

    protected void addCalculatedContent(Project project, Layout layout) {
        SearchService searchService = Services.getService(SearchService.class);
        if (searchService != null) {
            SearchResult<Project> relatedProjects = searchService.getRelatedProjects(project, 5);
            for (SearchHit<Project> hit : relatedProjects.getResult()) {
                ExternalResource externalResource = new ExternalResource("/projects/" + hit.getEntity().getProjectId());
                String content = HSPACE + "<a href=" + externalResource.getURL() + ">" + hit.getEntity().getName()
                        + "*</a>";
                Label label = new Label(content, Label.CONTENT_XHTML);
                layout.addComponent(label);
            }
            Label label = new Label(HSPACE + "*calculated based on similarities between the projects",
                    Label.CONTENT_XHTML);
            label.setStyleName("light");//$NON-NLS-1$
            layout.addComponent(label);

        }
    }

    @Override


    @Override
    public boolean isVisible(Project project, String loggedInUserId) {
        RelatedProjectsExt ext = project.getExtension(RelatedProjectsExt.class);
        if (ext == null || ext.getRelatedProjects().isEmpty()) {
            return false;
        } else {
            return true;

Lines 15-19 public abstract class AbstractInfoBox { Link Here

(-)a/org.eclipse.skalli.view.ext/src/main/java/org/eclipse/skalli/view/ext/AbstractInfoBox.java (+1 lines)
15	protected static final String STYLE_LABEL = "infolabel";	15	protected static final String STYLE_LABEL = "infolabel";
16	protected static final String STYLE_LINK = "infolink";	16	protected static final String STYLE_LINK = "infolink";
17	protected static final String STYLE_TEAMLABEL = "teamlabel";	17	protected static final String STYLE_TEAMLABEL = "teamlabel";
		18	protected static final String HSPACE = "    "; //$NON-NLS-1$
18		19
19	}	20	}

Lines 7-12 Link Here

(-)a/org.eclipse.skalli.view/VAADIN/themes/simple/styles.css (+1 lines)
7	@import url(styles_tray.css);	7	@import url(styles_tray.css);
8	@import url(styles_peoplesearch.css);	8	@import url(styles_peoplesearch.css);
9	@import url(styles_multitext.css);	9	@import url(styles_multitext.css);
		10	@import url(styles_multicombobox.css);
10		11
11	.v-app {	12	.v-app {
12	background: #fff;	13	background: #fff;




.multicombobox-layout {
    
}

.multicombobox-line {
    margin-bottom: 5px;
}

.multicombobox-btn {
    margin-left: 5px;
    margin-top: 5px;
}

.multicombobox-btn .v-button-caption {
    font-size: x-small;
}




/*******************************************************************************
 * Copyright (c) 2010, 2011 SAP AG and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     SAP AG - initial API and implementation
 *******************************************************************************/
package org.eclipse.skalli.view.component;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.UUID;

import org.apache.commons.lang.StringUtils;
import org.eclipse.skalli.api.java.ProjectService;
import org.eclipse.skalli.common.Services;
import org.eclipse.skalli.common.util.UUIDList;
import org.eclipse.skalli.model.core.Project;
import org.eclipse.skalli.model.ext.PropertyName;

import com.vaadin.data.Item;
import com.vaadin.data.Validator.InvalidValueException;
import com.vaadin.data.util.IndexedContainer;
import com.vaadin.ui.AbstractSelect;
import com.vaadin.ui.AbstractSelect.Filtering;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickEvent;
import com.vaadin.ui.ComboBox;
import com.vaadin.ui.CustomField;
import com.vaadin.ui.HorizontalLayout;
import com.vaadin.ui.Select;
import com.vaadin.ui.VerticalLayout;

public class MultiComboBox extends CustomField {

    private static final long serialVersionUID = -2946220818606365985L;

    private static final String STYLE_LAYOUT = "multicombobox-layout";
    private static final String STYLE_LINE_LAYOUT = "multicombobox-line";
    private static final String STYLE_BUTTON = "multicombobox-btn";

    private UUIDList values;
    private VerticalLayout layout;
    private List<ComboBoxElement> comboBoxEntries;
    private String description;
    private boolean readOnly;
    private int columns;

    private static class ComboBoxElement {
        public ComboBoxElement(ComboBox comboBox) {
            this.comboBox = comboBox;
            comboBox.setItemCaptionPropertyId(ProjectDataSource.PROPERTY_DISPLAYNAME);
            comboBox.setItemCaptionMode(AbstractSelect.ITEM_CAPTION_MODE_PROPERTY);
            comboBox.setFilteringMode(Filtering.FILTERINGMODE_CONTAINS);
            comboBox.setImmediate(true);
            comboBox.setNewItemsAllowed(false);
            comboBox.setNullSelectionAllowed(true);
        }

        ComboBox comboBox;
        Button removeButton;
    }

    public MultiComboBox(String caption, UUIDList values) {
        if (values == null) {
            throw new IllegalArgumentException("argument 'values' must not be null");
        }
        setCaption(caption);
        this.values = values;
        init(values);
        layout = new VerticalLayout();
        layout.setStyleName(STYLE_LAYOUT);
        renderComboBoxes();
        setCompositionRoot(layout);
    }

    private void renderComboBoxes() {
        boolean hasMultipleEntries = comboBoxEntries.size() > 1;
        int last = comboBoxEntries.size() - 1;
        for (int i = 0; i <= last; ++i) {
            ComboBoxElement comboBoxEntry = comboBoxEntries.get(i);
            HorizontalLayout horLayout = new HorizontalLayout();
            horLayout.setStyleName(STYLE_LINE_LAYOUT);
            ComboBox comboBox = comboBoxEntry.comboBox;
            if (comboBox.getValue() == null) {
                comboBox.setEnabled(!readOnly);
            } else {
                comboBox.setReadOnly(readOnly);
            }
            horLayout.addComponent(comboBox);

            if (hasMultipleEntries) {
                Button b = createRemoveButton();
                comboBoxEntry.removeButton = b;
                horLayout.addComponent(b);
            }
            if (i == last) {
                horLayout.addComponent(createAddButton());
            }

            layout.addComponent(horLayout);
        }
    }

    private void init(UUIDList values) {
        comboBoxEntries = new ArrayList<ComboBoxElement>();
        if (values != null && !values.isEmpty()) {
            for (UUID value : values) {
                ComboBox comboBox = createComboBox(value);
                comboBoxEntries.add(new ComboBoxElement(comboBox));
            }
        } else {
            ComboBox comboBox = createComboBox(null);
            comboBoxEntries.add(new ComboBoxElement(comboBox));
        }
    }

    private ComboBox createComboBox(UUID uuid) {
        ComboBox comboBox = new ComboBox(null, new ProjectDataSource());
        if (description != null) {
            comboBox.setDescription(description);
        }
        if (uuid != null) {
            ProjectService projectService = Services.getRequiredService(ProjectService.class);
            Project project = projectService.getByUUID(uuid);
            comboBox.select(project);
        }
        return comboBox;
    }

    public void setColumns(int columns) {
        this.columns = columns;
        for (ComboBoxElement entry : comboBoxEntries) {
            entry.comboBox.setWidth(columns, Select.UNITS_EM);
        }
    }

    private Button createAddButton() {
        Button b = new Button("Add");
        b.setStyleName(Button.STYLE_LINK);
        b.addStyleName(STYLE_BUTTON);
        b.setDescription("Add another entry");
        b.setEnabled(!readOnly);
        b.addListener(new Button.ClickListener() {
            @Override
            public void buttonClick(ClickEvent event) {
                ComboBox cb = createComboBox(null);
                cb.setWidth(columns, Select.UNITS_EM);
                comboBoxEntries.add(new ComboBoxElement(cb));
                layout.removeAllComponents();
                renderComboBoxes();
            }
        });
        return b;
    }

    private Button createRemoveButton() {
        Button b = new Button("Remove");
        b.setStyleName(Button.STYLE_LINK);
        b.addStyleName(STYLE_BUTTON);
        b.setDescription("Remove this entry");
        b.addListener(new Button.ClickListener() {
            @Override
            public void buttonClick(ClickEvent event) {
                Button b = event.getButton();
                Iterator<ComboBoxElement> it = comboBoxEntries.iterator();
                while (it.hasNext()) {
                    ComboBoxElement element = it.next();
                    if (element.removeButton == b) {
                        it.remove();
                        break;
                    }
                }
                layout.removeAllComponents();
                renderComboBoxes();
            }
        });
        return b;
    }

    @Override
    public void setDescription(String description) {
        this.description = description;
        for (ComboBoxElement element : comboBoxEntries) {
            element.comboBox.setDescription(description);
        }
    }

    @Override
    public Object getValue() {
        UUIDList uuid = new UUIDList(comboBoxEntries.size());
        copyValues(uuid);
        return uuid;
    }

    @Override
    public void commit() throws SourceException, InvalidValueException {
        values.clear();
        copyValues(values);
    }

    private void copyValues(UUIDList values) {
        for (ComboBoxElement entry : comboBoxEntries) {
            Project project = (Project) entry.comboBox.getValue();
            if (project == null) {
                return;
            }
            UUID value = project.getUuid();
            if (StringUtils.isNotBlank(value.toString())) {
                values.add(value);
            }
        }
    }

    @Override
    public Class<?> getType() {
        return Collection.class;
    }

    private static class ProjectDataSource extends IndexedContainer {

        private static final long serialVersionUID = 8192530422436522676L;

        @PropertyName(position = 0)
        public static final Object PROPERTY_DISPLAYNAME = "displayName";

        public ProjectDataSource() {
            super();
            addContainerProperty(Project.PROPERTY_NAME, String.class, null);
            addContainerProperty(Project.PROPERTY_PROJECTID, String.class, null);
            addContainerProperty(PROPERTY_DISPLAYNAME, String.class, null);

            ProjectService projectService = Services.getRequiredService(ProjectService.class);
            List<Project> projects = projectService.getAll();
            for (Project project : projects) {
                addItem(project);
            }
            sort(new Object[] { Project.PROPERTY_NAME, Project.PROPERTY_PROJECTID }, new boolean[] { true, true });
        }

        private Item addItem(Project project) {
            // item key = project instance
            Item item = getItem(project);
            if (item == null) {
                item = super.addItem(project); // IndexedContainer#addItem return null, if entry already exists!!!
            }
            if (item != null) {
                String projectId = project.getProjectId();
                String name = project.getName();
                item.getItemProperty(Project.PROPERTY_NAME).setValue(name);
                item.getItemProperty(Project.PROPERTY_PROJECTID).setValue(projectId);
                item.getItemProperty(PROPERTY_DISPLAYNAME).setValue(name + " <" + projectId + ">");
            }
            return item;
        }
    }

    @Override
    public void setReadOnly(boolean readOnly) {
        this.readOnly = readOnly;
        layout.removeAllComponents();
        renderComboBoxes();
    }

    @Override
    public boolean isReadOnly() {
        return readOnly;
    }

}

Return to bug 350359

Added Link Here

(-)a/org.eclipse.skalli.model.ext.misc/OSGI-INF/ExtensionServiceRelatedProjects.xml (+18 lines)
1	<?xml version="1.0" encoding="UTF-8"?><!--
2	Copyright (c) 2010, 2011 SAP AG and others.
3	All rights reserved. This program and the accompanying materials
4	are made available under the terms of the Eclipse Public License v1.0
5	which accompanies this distribution, and is available at
6	http://www.eclipse.org/legal/epl-v10.html
7
8	Contributors:
9	SAP AG - initial API and implementation
10	-->
11
12	<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="org.eclipse.skalli.model.ext.related">
13	<implementation class="org.eclipse.skalli.model.ext.misc.internal.ExtensionServiceRelatedProjects"/>
14	<service>
15	<provide interface="org.eclipse.skalli.model.ext.ExtensionService"/>
16	</service>
17	</scr:component>
18

Added Link Here

(-)a/org.eclipse.skalli.model.ext.misc/src/main/java/org/eclipse/skalli/model/ext/misc/RelatedProjectsExt.java (+49 lines)
1	/*******************************************************************************
2	* Copyright (c) 2010, 2011 SAP AG and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* SAP AG - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.skalli.model.ext.misc;
12
13	import org.eclipse.skalli.common.util.UUIDList;
14	import org.eclipse.skalli.model.ext.ExtensionEntityBase;
15	import org.eclipse.skalli.model.ext.PropertyName;
16
17	public class RelatedProjectsExt extends ExtensionEntityBase {
18	public static final String MODEL_VERSION = "1.0"; //$NON-NLS-1$
19	public static final String NAMESPACE = "http://www.eclipse.org/skalli/2010/Model/Extension-Related"; //$NON-NLS-1$
20
21	@PropertyName(position = 0)
22	public static final String PROPERTY_CALCULATED = "calculated";
23
24	@PropertyName(position = 1)
25	public static final String PROPERTY_RELATED_PROJECT = "relatedProjects"; //$NON-NLS-1$
26
27	private UUIDList relatedProjects;
28	private boolean calculated;
29
30	public boolean getCalculated() {
31	return calculated;
32	}
33
34	public void setCalculated(boolean calculated) {
35	this.calculated = calculated;
36	}
37
38	public UUIDList getRelatedProjects() {
39	if (relatedProjects == null) {
40	relatedProjects = new UUIDList();
41	}
42	return relatedProjects;
43	}
44
45	public void setRelatedProjects(UUIDList relatedProjects) {
46	this.relatedProjects = new UUIDList(relatedProjects);
47	}
48
49	}

Added Link Here

(-)a/org.eclipse.skalli.view.ext.impl/OSGI-INF/ExtensionServiceRelatedProjectsExtEditForm.xml (+19 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	Copyright (c) 2010, 2011 SAP AG and others.
4	All rights reserved. This program and the accompanying materials
5	are made available under the terms of the Eclipse Public License v1.0
6	which accompanies this distribution, and is available at
7	http://www.eclipse.org/legal/epl-v10.html
8
9	Contributors:
10	SAP AG - initial API and implementation
11	-->
12
13	<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="org.eclipse.skalli.view.ext.impl.internal.forms.related">
14	<implementation class="org.eclipse.skalli.view.ext.impl.internal.forms.RelatedProjectsExtEditForm"/>
15	<service>
16	<provide interface="org.eclipse.skalli.view.ext.ExtensionFormService"/>
17	</service>
18	</scr:component>
19

Added Link Here

(-)a/org.eclipse.skalli.view.ext.impl/src/main/java/org/eclipse/skalli/view/ext/impl/internal/forms/RelatedProjectsExtEditForm.java (+98 lines)
1	/*******************************************************************************
2	* Copyright (c) 2010, 2011 SAP AG and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* SAP AG - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.skalli.view.ext.impl.internal.forms;
12
13	import org.eclipse.skalli.common.util.UUIDList;
14	import org.eclipse.skalli.model.core.Project;
15	import org.eclipse.skalli.model.ext.misc.RelatedProjectsExt;
16	import org.eclipse.skalli.view.component.MultiComboBox;
17	import org.eclipse.skalli.view.ext.AbstractExtensionFormService;
18	import org.eclipse.skalli.view.ext.DefaultProjectFieldFactory;
19	import org.eclipse.skalli.view.ext.ProjectEditContext;
20
21	import com.vaadin.data.Item;
22	import com.vaadin.data.Property.ValueChangeListener;
23	import com.vaadin.data.util.BeanItem;
24	import com.vaadin.ui.CheckBox;
25	import com.vaadin.ui.Field;
26	import com.vaadin.ui.FormFieldFactory;
27
28	public class RelatedProjectsExtEditForm extends AbstractExtensionFormService<RelatedProjectsExt> {
29
30	@Override
31	public String getIconPath() {
32	return "res/icons/relProjects.png"; //$NON-NLS-1$
33	}
34
35	@Override
36	public float getRank() {
37	return 1.5f;
38	}
39
40	@Override
41	protected FormFieldFactory getFieldFactory(Project project, ProjectEditContext context) {
42	return new FieldFactory(project, context);
43	}
44
45	@Override
46	protected Item getItemDataSource(Project project) {
47	return new BeanItem<RelatedProjectsExt>(getExtension(project));
48	}
49
50	private class FieldFactory extends DefaultProjectFieldFactory<RelatedProjectsExt> {
51
52	private static final long serialVersionUID = 939519704283769367L;
53	private RelatedProjectsExt extension;
54	private Field comboBox;
55
56	public FieldFactory(Project project, ProjectEditContext context) {
57	super(project, RelatedProjectsExt.class, context);
58	this.extension = getExtension(project);
59	}
60
61	@Override
62	protected Field createField(Object propertyId, String caption) {
63
64	if (RelatedProjectsExt.PROPERTY_CALCULATED.equals(propertyId)) {
65	final CheckBox field = new CheckBox(caption);
66	field.setImmediate(true);
67	field.addListener(new ValueChangeListener() {
68
69	private static final long serialVersionUID = 3996507266934851419L;
70
71	@Override
72	public void valueChange(com.vaadin.data.Property.ValueChangeEvent event) {
73	if (comboBox != null) {
74	comboBox.setEnabled(!field.booleanValue());
75	}
76	}
77	});
78	return field;
79	} else if (RelatedProjectsExt.PROPERTY_RELATED_PROJECT.equals(propertyId)) {
80	UUIDList ids = extension.getRelatedProjects();
81	comboBox = new MultiComboBox(caption, ids);
82	comboBox.setEnabled(!extension.getCalculated());
83	return comboBox;
84	}
85	return null;
86	}
87	}
88
89	@Override
90	public Class<RelatedProjectsExt> getExtensionClass() {
91	return RelatedProjectsExt.class;
92	}
93
94	@Override
95	public RelatedProjectsExt newExtensionInstance() {
96	return new RelatedProjectsExt();
97	}
98	}

Added Link Here

(-)a/org.eclipse.skalli.view/VAADIN/themes/simple/styles_multicombobox.css (+16 lines)
1	.multicombobox-layout {
2
3	}
4
5	.multicombobox-line {
6	margin-bottom: 5px;
7	}
8
9	.multicombobox-btn {
10	margin-left: 5px;
11	margin-top: 5px;
12	}
13
14	.multicombobox-btn .v-button-caption {
15	font-size: x-small;
16	}

Added Link Here

(-)a/org.eclipse.skalli.view/src/main/java/org/eclipse/skalli/view/component/MultiComboBox.java (-1 / +275 lines)
0	-	1	/*******************************************************************************
		2	* Copyright (c) 2010, 2011 SAP AG and others.
		3	* All rights reserved. This program and the accompanying materials
		4	* are made available under the terms of the Eclipse Public License v1.0
		5	* which accompanies this distribution, and is available at
		6	* http://www.eclipse.org/legal/epl-v10.html
		7	*
		8	* Contributors:
		9	* SAP AG - initial API and implementation
		10	*******************************************************************************/
		11	package org.eclipse.skalli.view.component;
		12
		13	import java.util.ArrayList;
		14	import java.util.Collection;
		15	import java.util.Iterator;
		16	import java.util.List;
		17	import java.util.UUID;
		18
		19	import org.apache.commons.lang.StringUtils;
		20	import org.eclipse.skalli.api.java.ProjectService;
		21	import org.eclipse.skalli.common.Services;
		22	import org.eclipse.skalli.common.util.UUIDList;
		23	import org.eclipse.skalli.model.core.Project;
		24	import org.eclipse.skalli.model.ext.PropertyName;
		25
		26	import com.vaadin.data.Item;
		27	import com.vaadin.data.Validator.InvalidValueException;
		28	import com.vaadin.data.util.IndexedContainer;
		29	import com.vaadin.ui.AbstractSelect;
		30	import com.vaadin.ui.AbstractSelect.Filtering;
		31	import com.vaadin.ui.Button;
		32	import com.vaadin.ui.Button.ClickEvent;
		33	import com.vaadin.ui.ComboBox;
		34	import com.vaadin.ui.CustomField;
		35	import com.vaadin.ui.HorizontalLayout;
		36	import com.vaadin.ui.Select;
		37	import com.vaadin.ui.VerticalLayout;
		38
		39	public class MultiComboBox extends CustomField {
		40
		41	private static final long serialVersionUID = -2946220818606365985L;
		42
		43	private static final String STYLE_LAYOUT = "multicombobox-layout";
		44	private static final String STYLE_LINE_LAYOUT = "multicombobox-line";
		45	private static final String STYLE_BUTTON = "multicombobox-btn";
		46
		47	private UUIDList values;
		48	private VerticalLayout layout;
		49	private List<ComboBoxElement> comboBoxEntries;
		50	private String description;
		51	private boolean readOnly;
		52	private int columns;
		53
		54	private static class ComboBoxElement {
		55	public ComboBoxElement(ComboBox comboBox) {
		56	this.comboBox = comboBox;
		57	comboBox.setItemCaptionPropertyId(ProjectDataSource.PROPERTY_DISPLAYNAME);
		58	comboBox.setItemCaptionMode(AbstractSelect.ITEM_CAPTION_MODE_PROPERTY);
		59	comboBox.setFilteringMode(Filtering.FILTERINGMODE_CONTAINS);
		60	comboBox.setImmediate(true);
		61	comboBox.setNewItemsAllowed(false);
		62	comboBox.setNullSelectionAllowed(true);
		63	}
		64
		65	ComboBox comboBox;
66	Button removeButton;
67	}
68
69	public MultiComboBox(String caption, UUIDList values) {
70	if (values == null) {
71	throw new IllegalArgumentException("argument 'values' must not be null");
72	}
73	setCaption(caption);
74	this.values = values;
75	init(values);
76	layout = new VerticalLayout();
77	layout.setStyleName(STYLE_LAYOUT);
78	renderComboBoxes();
79	setCompositionRoot(layout);
80	}
81
82	private void renderComboBoxes() {
83	boolean hasMultipleEntries = comboBoxEntries.size() > 1;
84	int last = comboBoxEntries.size() - 1;
85	for (int i = 0; i <= last; ++i) {
86	ComboBoxElement comboBoxEntry = comboBoxEntries.get(i);
87	HorizontalLayout horLayout = new HorizontalLayout();
88	horLayout.setStyleName(STYLE_LINE_LAYOUT);
89	ComboBox comboBox = comboBoxEntry.comboBox;
90	if (comboBox.getValue() == null) {
91	comboBox.setEnabled(!readOnly);
92	} else {
93	comboBox.setReadOnly(readOnly);
94	}
95	horLayout.addComponent(comboBox);
96
97	if (hasMultipleEntries) {
98	Button b = createRemoveButton();
99	comboBoxEntry.removeButton = b;
100	horLayout.addComponent(b);
101	}
102	if (i == last) {
103	horLayout.addComponent(createAddButton());
104	}
105
106	layout.addComponent(horLayout);
107	}
108	}
109
110	private void init(UUIDList values) {
111	comboBoxEntries = new ArrayList<ComboBoxElement>();
112	if (values != null && !values.isEmpty()) {
113	for (UUID value : values) {
114	ComboBox comboBox = createComboBox(value);
115	comboBoxEntries.add(new ComboBoxElement(comboBox));
116	}
117	} else {
118	ComboBox comboBox = createComboBox(null);
119	comboBoxEntries.add(new ComboBoxElement(comboBox));
120	}
121	}
122
123	private ComboBox createComboBox(UUID uuid) {
124	ComboBox comboBox = new ComboBox(null, new ProjectDataSource());
125	if (description != null) {
126	comboBox.setDescription(description);
127	}
128	if (uuid != null) {
129	ProjectService projectService = Services.getRequiredService(ProjectService.class);
130	Project project = projectService.getByUUID(uuid);
131	comboBox.select(project);
132	}
133	return comboBox;
134	}
135
136	public void setColumns(int columns) {
137	this.columns = columns;
138	for (ComboBoxElement entry : comboBoxEntries) {
139	entry.comboBox.setWidth(columns, Select.UNITS_EM);
140	}
141	}
142
143	private Button createAddButton() {
144	Button b = new Button("Add");
145	b.setStyleName(Button.STYLE_LINK);
146	b.addStyleName(STYLE_BUTTON);
147	b.setDescription("Add another entry");
148	b.setEnabled(!readOnly);
149	b.addListener(new Button.ClickListener() {
150	@Override
151	public void buttonClick(ClickEvent event) {
152	ComboBox cb = createComboBox(null);
153	cb.setWidth(columns, Select.UNITS_EM);
154	comboBoxEntries.add(new ComboBoxElement(cb));
155	layout.removeAllComponents();
156	renderComboBoxes();
157	}
158	});
159	return b;
160	}
161
162	private Button createRemoveButton() {
163	Button b = new Button("Remove");
164	b.setStyleName(Button.STYLE_LINK);
165	b.addStyleName(STYLE_BUTTON);
166	b.setDescription("Remove this entry");
167	b.addListener(new Button.ClickListener() {
168	@Override
169	public void buttonClick(ClickEvent event) {
170	Button b = event.getButton();
171	Iterator<ComboBoxElement> it = comboBoxEntries.iterator();
172	while (it.hasNext()) {
173	ComboBoxElement element = it.next();
174	if (element.removeButton == b) {
175	it.remove();
176	break;
177	}
178	}
179	layout.removeAllComponents();
180	renderComboBoxes();
181	}
182	});
183	return b;
184	}
185
186	@Override
187	public void setDescription(String description) {
188	this.description = description;
189	for (ComboBoxElement element : comboBoxEntries) {
190	element.comboBox.setDescription(description);
191	}
192	}
193
194	@Override
195	public Object getValue() {
196	UUIDList uuid = new UUIDList(comboBoxEntries.size());
197	copyValues(uuid);
198	return uuid;
199	}
200
201	@Override
202	public void commit() throws SourceException, InvalidValueException {
203	values.clear();
204	copyValues(values);
205	}
206
207	private void copyValues(UUIDList values) {
208	for (ComboBoxElement entry : comboBoxEntries) {
209	Project project = (Project) entry.comboBox.getValue();
210	if (project == null) {
211	return;
212	}
213	UUID value = project.getUuid();
214	if (StringUtils.isNotBlank(value.toString())) {
215	values.add(value);
216	}
217	}
218	}
219
220	@Override
221	public Class<?> getType() {
222	return Collection.class;
223	}
224
225	private static class ProjectDataSource extends IndexedContainer {
226
227	private static final long serialVersionUID = 8192530422436522676L;
228
229	@PropertyName(position = 0)
230	public static final Object PROPERTY_DISPLAYNAME = "displayName";
231
232	public ProjectDataSource() {
233	super();
234	addContainerProperty(Project.PROPERTY_NAME, String.class, null);
235	addContainerProperty(Project.PROPERTY_PROJECTID, String.class, null);
236	addContainerProperty(PROPERTY_DISPLAYNAME, String.class, null);
237
238	ProjectService projectService = Services.getRequiredService(ProjectService.class);
239	List<Project> projects = projectService.getAll();
240	for (Project project : projects) {
241	addItem(project);
242	}
243	sort(new Object[] { Project.PROPERTY_NAME, Project.PROPERTY_PROJECTID }, new boolean[] { true, true });
244	}
245
246	private Item addItem(Project project) {
247	// item key = project instance
248	Item item = getItem(project);
249	if (item == null) {
250	item = super.addItem(project); // IndexedContainer#addItem return null, if entry already exists!!!
251	}
252	if (item != null) {
253	String projectId = project.getProjectId();
254	String name = project.getName();
255	item.getItemProperty(Project.PROPERTY_NAME).setValue(name);
256	item.getItemProperty(Project.PROPERTY_PROJECTID).setValue(projectId);
257	item.getItemProperty(PROPERTY_DISPLAYNAME).setValue(name + " <" + projectId + ">");
258	}
259	return item;
260	}
261	}
262
263	@Override
264	public void setReadOnly(boolean readOnly) {
265	this.readOnly = readOnly;
266	layout.removeAllComponents();
267	renderComboBoxes();
268	}
269
270	@Override
271	public boolean isReadOnly() {
272	return readOnly;
273	}
274
275	}