Menu
▾
▴
[Fudaa-svn-commit] SF.net SVN: fudaa:[9516] trunk/soft/fudaa-crue
|
From: <de...@us...> - 2017-01-11 22:10:07
|
Revision: 9516
http://sourceforge.net/p/fudaa/svn/9516
Author: deniger
Date: 2017-01-11 22:10:05 +0000 (Wed, 11 Jan 2017)
Log Message:
-----------
javadoc
Modified Paths:
--------------
trunk/soft/fudaa-crue/ui-common/src/main/java/org/fudaa/fudaa/crue/common/services/AbstractSelectedEMHService.java
trunk/soft/fudaa-crue/ui-modelling/src/main/java/org/fudaa/fudaa/crue/modelling/services/ModellingSelectedEMHService.java
trunk/soft/fudaa-crue/ui-report/src/main/java/org/fudaa/fudaa/crue/report/service/ReportSelectedEMHService.java
Modified: trunk/soft/fudaa-crue/ui-common/src/main/java/org/fudaa/fudaa/crue/common/services/AbstractSelectedEMHService.java
===================================================================
--- trunk/soft/fudaa-crue/ui-common/src/main/java/org/fudaa/fudaa/crue/common/services/AbstractSelectedEMHService.java 2017-01-11 21:53:56 UTC (rev 9515)
+++ trunk/soft/fudaa-crue/ui-common/src/main/java/org/fudaa/fudaa/crue/common/services/AbstractSelectedEMHService.java 2017-01-11 22:10:05 UTC (rev 9516)
@@ -12,33 +12,74 @@
import org.openide.util.lookup.InstanceContent;
/**
- * conserve les UID des EMH sélectionnés
+ * conserve les UID des EMH sélectionnés dans une perspective.
*
+ * <table border="1" cellpadding="3" cellspacing="0" summary="lookups">
+ * <tr>
+ * <th align="left">Lookup</th>
+ * <th align="left">Commentaire</th>
+ * <th align="left">Méthodes utilisant le lookup</th>
+ * </tr>
+ * <tr>
+ * <td>{@link java.lang.Long}: </td>
+ * <td> les uids des EMHS sélectionnés.
+ * </td>
+ * <td>{@link #setSelectedEMHs(java.util.Collection)}, {@link #getSelectedUids()}, {@link #clearContent()}</td>
+ * </tr>
+ * </table>
+ *
* @author Frederic Deniger
*/
public class AbstractSelectedEMHService implements Lookup.Provider {
- private InstanceContent dynamicContent = new InstanceContent();
- private Lookup lookup = new AbstractLookup(dynamicContent);
+ /**
+ * le contenu du lookup du service
+ */
+ private final InstanceContent dynamicContent = new InstanceContent();
+ /**
+ * le lookup du service
+ */
+ private final Lookup lookup = new AbstractLookup(dynamicContent);
+ /**
+ * true si le lookup est en cours de modifications ( vaudra true lors de l'ajout de plusieurs éléments et false à la fin de l'action).
+ */
+ private boolean updating;
+ /**
+ *
+ * @return le lookup du service
+ */
@Override
public Lookup getLookup() {
return lookup;
}
- private boolean updating;
+ /**
+ * @return si la selection est en cours de mise à jour.
+ */
public boolean isUpdating() {
return updating;
}
+ /**
+ * efface la sélection en cours et la remplace par la nouvelle sélection {@code emhs}.
+ * Au cours des opérations {@link #isUpdating()} vaudra true, puis false à la fin de la modification du lookup du service
+ *
+ * @see EMH#getUiId()
+ * @param emhs la nouvelle sélectiond'EMHs ( on récupère les uid).: ne doit pas être null.
+ */
public void setSelectedEMHs(Collection<EMH> emhs) {
+ //on nettoie le contenu actuel.
clearContent();
+ //on ajoute la nouvelle selection
final int size = emhs.size();
+ //en cours de modification si au moins un element à ajouter
if (size > 1) {
updating = true;
}
int idx = 0;
for (EMH emh : emhs) {
+ //pour envoyer un event à la dernière modification
if (++idx == size) {
updating = false;
}
@@ -47,14 +88,24 @@
updating = false;
}
+ /**
+ * efface la sélection en cours et la remplace par la nouvelle sélection {@code emhs}.
+ * Au cours des opérations {@link #isUpdating()} vaudra true, puis false à la fin de la modification du lookup du service
+ *
+ * @param uids la nouvelle sélection d'uid ne doit pas être null
+ */
public void setSelectedUids(Collection<Long> uids) {
+ //on nettoie le contenu actuel.
clearContent();
+ //on ajoute la nouvelle selection
final int size = uids.size();
+ //en cours de modification si au moins un element à ajouter
if (size > 1) {
updating = true;
}
int idx = 0;
for (Long uid : uids) {
+ //pour envoyer un event à la dernière modification
if (++idx == size) {
updating = false;
}
@@ -63,11 +114,19 @@
updating = false;
}
+ /**
+ *
+ * @return ensemble des uid en cours de sélection. Jamais null.
+ */
public Set<Long> getSelectedUids() {
return new HashSet<Long>(lookup.lookupAll(Long.class));
}
- public void clearContent() {
+ /**
+ * Supprime la sélection courante.
+ */
+ private void clearContent() {
+ //on recupere tous les uids sélectionnés et on les enleve du lookup.
Collection<? extends Long> lookupAll = lookup.lookupAll(Long.class);
final int size = lookupAll.size();
if (size > 1) {
@@ -75,6 +134,7 @@
}
int idx = 0;
for (Long uid : lookupAll) {
+ //pour envoyer un event à la dernière modification
if (++idx == size) {
updating = false;
}
Modified: trunk/soft/fudaa-crue/ui-modelling/src/main/java/org/fudaa/fudaa/crue/modelling/services/ModellingSelectedEMHService.java
===================================================================
--- trunk/soft/fudaa-crue/ui-modelling/src/main/java/org/fudaa/fudaa/crue/modelling/services/ModellingSelectedEMHService.java 2017-01-11 21:53:56 UTC (rev 9515)
+++ trunk/soft/fudaa-crue/ui-modelling/src/main/java/org/fudaa/fudaa/crue/modelling/services/ModellingSelectedEMHService.java 2017-01-11 22:10:05 UTC (rev 9516)
@@ -8,13 +8,19 @@
import org.openide.util.lookup.ServiceProvider;
/**
- * conserve les UID des EMH sélectionnés
+ * conserve les UID des EMH sélectionnées. Pour les lookup voir {@link org.fudaa.fudaa.crue.common.services.AbstractSelectedEMHService}.
*
+ * @see org.fudaa.fudaa.crue.common.services.AbstractSelectedEMHService
+ *
* @author Frederic Deniger
*/
@ServiceProvider(service = ModellingSelectedEMHService.class)
public class ModellingSelectedEMHService extends AbstractSelectedEMHService implements Lookup.Provider {
+ /**
+ *
+ * @return le lookup du service
+ */
@Override
public Lookup getLookup() {
return super.getLookup();
Modified: trunk/soft/fudaa-crue/ui-report/src/main/java/org/fudaa/fudaa/crue/report/service/ReportSelectedEMHService.java
===================================================================
--- trunk/soft/fudaa-crue/ui-report/src/main/java/org/fudaa/fudaa/crue/report/service/ReportSelectedEMHService.java 2017-01-11 21:53:56 UTC (rev 9515)
+++ trunk/soft/fudaa-crue/ui-report/src/main/java/org/fudaa/fudaa/crue/report/service/ReportSelectedEMHService.java 2017-01-11 22:10:05 UTC (rev 9516)
@@ -8,13 +8,19 @@
import org.openide.util.lookup.ServiceProvider;
/**
- * conserve les UID des EMH sélectionnés
+ * conserve les UID des EMH sélectionnées. Pour les lookup voir {@link org.fudaa.fudaa.crue.common.services.AbstractSelectedEMHService}.
*
+ * @see org.fudaa.fudaa.crue.common.services.AbstractSelectedEMHService
+ *
* @author Frederic Deniger
*/
@ServiceProvider(service = ReportSelectedEMHService.class)
public class ReportSelectedEMHService extends AbstractSelectedEMHService implements Lookup.Provider {
+ /**
+ *
+ * @return le lookup du service
+ */
@Override
public Lookup getLookup() {
return super.getLookup();
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
