Author: kono
Date: 2011-11-15 10:53:49 -0800 (Tue, 15 Nov 2011)
New Revision: 27469
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/AbstractVisualPropertyDependency.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewPanel.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/MappingFunctionFactoryManager.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/SelectedVisualStyleManager.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependency.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependencyManager.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VizMapGUI.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/AbstractVisualPropertyEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/EditorManager.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ListEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedEvent.java
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedListener.java
Log:
Documents had been updated.
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/AbstractVisualPropertyDependency.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/AbstractVisualPropertyDependency.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/AbstractVisualPropertyDependency.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -6,24 +6,34 @@
import org.cytoscape.view.model.VisualProperty;
/**
+ * All VP dependency should extends this.
+ *
+ * TODO: refactor dependnecy.
+ *
* @CyAPI.Abstract.Class
*/
-public abstract class AbstractVisualPropertyDependency implements
- VisualPropertyDependency {
+public abstract class AbstractVisualPropertyDependency implements
VisualPropertyDependency {
+
+ private final String displayName;
- private final String displayName;
protected final Set<VisualProperty<?>> group;
-
+
public AbstractVisualPropertyDependency(final String displayName) {
this.displayName = displayName;
group = new HashSet<VisualProperty<?>>();
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getDisplayName() {
return displayName;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public Set<VisualProperty<?>> getVisualProperties() {
return group;
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewEditor.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewEditor.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -8,6 +8,9 @@
* Default View Editor is the component to display available visual properties
* and its default view for given Visual Style.
* This component will be provided as a service.
+ *
+ * @CyAPI.Api.Interface
+ *
*/
public interface DefaultViewEditor {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewPanel.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewPanel.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/DefaultViewPanel.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -6,6 +6,7 @@
/**
* GUI component to display default appearance of current Visual Style.
*
+ * @CyAPI.Api.Interface
*/
public interface DefaultViewPanel {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/MappingFunctionFactoryManager.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/MappingFunctionFactoryManager.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/MappingFunctionFactoryManager.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -5,11 +5,24 @@
import org.cytoscape.view.vizmap.VisualMappingFunctionFactory;
/**
+ * Manages factories to create actual mappings
(discrete/passthrough/continuous).
+ *
* @CyAPI.Api.Interface
*/
public interface MappingFunctionFactoryManager {
+ /**
+ * Returns all available factories.
+ *
+ * @return all mapping function factories.
+ */
Collection<VisualMappingFunctionFactory> getFactories();
+ /**
+ * Factory for the specific mapping type.
+ *
+ * @param mappingType
+ * @return mapping factory for the given mapping type.
+ */
VisualMappingFunctionFactory getFactory(Class<?> mappingType);
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/SelectedVisualStyleManager.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/SelectedVisualStyleManager.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/SelectedVisualStyleManager.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -5,6 +5,7 @@
/**
* Manages current (selected) Visual Style. Selected style will be set by
* {@link
org.cytoscape.view.vizmap.gui.event.SelectedVisualStyleSwitchedListener}.
+ *
* @CyAPI.Api.Interface
*/
public interface SelectedVisualStyleManager {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependency.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependency.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependency.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -7,6 +7,7 @@
/**
* Defines the dependency of Visual Properties.
*
+ * @CyAPI.Api.Interface
*/
public interface VisualPropertyDependency {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependencyManager.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependencyManager.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VisualPropertyDependencyManager.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -3,10 +3,19 @@
import java.util.Collection;
/**
+ * Manager for dependencies.
+ *
+ * TODO: refactor dependency mechanism.
+ *
* @CyAPI.Api.Interface
*/
public interface VisualPropertyDependencyManager {
+ /**
+ * Returns all registered dependencies.
+ *
+ * @return all dependencies
+ */
Collection<VisualPropertyDependency> getDependencies();
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VizMapGUI.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VizMapGUI.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/VizMapGUI.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -36,8 +36,6 @@
package org.cytoscape.view.vizmap.gui;
-import java.awt.Component;
-
import javax.swing.JPanel;
@@ -58,6 +56,8 @@
* This component tracks the selected Visual Style.
* Because of this, Visual Style is editable even if current Network View does
not exist.
*
+ * @CyAPI.Api.Interface
+ *
*/
public interface VizMapGUI {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/AbstractVisualPropertyEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/AbstractVisualPropertyEditor.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/AbstractVisualPropertyEditor.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -45,7 +45,9 @@
/**
- * #ASKMIKE class/attribute comments, entire vizmap-gui-api needs looking over
+ * Abstract implementation of Visual Property Editor.
+ * All editors should extend this class.
+ *
* @param <T> The generic type of this AbstractVisualPropertyEditor.
*
* @CyAPI.Abstract.Class
@@ -71,16 +73,24 @@
this.propertyEditor = propertyEditor;
}
+ /**
+ * {@inheritDoc}
+ */
@Override public Class<T> getType() {
return this.type;
}
-
+
+ /**
+ * {@inheritDoc}
+ */
@Override public PropertyEditor getPropertyEditor() {
return propertyEditor;
}
-
+ /**
+ * {@inheritDoc}
+ */
@Override public T showVisualPropertyValueEditor() {
if(vpValueEditor == null) {
// Search value editor repository
@@ -91,21 +101,33 @@
return null;
}
-
+ /**
+ * {@inheritDoc}
+ */
@Override public TableCellRenderer getDiscreteTableCellRenderer() {
return discreteTableCellRenderer;
}
+
+ /**
+ * {@inheritDoc}
+ */
@Override public TableCellRenderer getContinuousTableCellRenderer() {
return continuousTableCellRenderer;
}
+ /**
+ * {@inheritDoc}
+ */
@Override public PropertyEditor getContinuousMappingEditor() throws
IllegalArgumentException {
return continuousEditor;
}
+ /**
+ * {@inheritDoc}
+ */
@Override public Icon getDefaultIcon(int width, int height) {
// By default, it does not return actual icon. This should be
implemented child classes.
return null;
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/EditorManager.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/EditorManager.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/EditorManager.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -47,12 +47,13 @@
/**
- * Manages currently available editors
+ * Manages all editor objects for ViaMap GUI.
+ *
*
+ * @CyAPI.Api.Interface
*/
public interface EditorManager {
-
/**
* Editor window state
*/
@@ -64,95 +65,112 @@
public static final String EDITOR_WINDOW_CLOSED =
"EDITOR_WINDOW_CLOSED";
/**
- * Listener for editor displayer service.
- *
- * @param va
- * DOCUMENT ME!
- * @param properties
- * DOCUMENT ME!
+ * Add value editor OSGi services.
+ *
+ * @param va New value editor to be added.
+ * @param properties OSGi service metadata.
*/
@SuppressWarnings("unchecked")
public void addValueEditor(ValueEditor<?> va, Map properties);
+
/**
- * Listener for OSGi service.
- *
- * @param va
- * DOCUMENT ME!
- * @param properties
- * DOCUMENT ME!
+ * Remove an editor from manager (through OSGi).
+ *
+ * @param va editor to be removed.
+ * @param properties OSGi metadata
*/
@SuppressWarnings("unchecked")
public void removeValueEditor(ValueEditor<?> va, Map properties);
-
+
+
/**
- * Display discrete value editor for this visual property.
- * @param <V> DOCUMENT ME!
- * @param parentComponent DOCUMENT ME!
- * @param type DOCUMENT ME!
- * @param initialVal DOCUMENT ME!
- *
- * @return DOCUMENT ME!
- *
+ * Display value editor to get a new value.
+ *
+ * @param parentComponent parent GUI component
+ * @param type Visual Property type to be edited
+ * @param initialVal default value for the editor.
+ *
+ * @return New value fot the given Visual Property.
+ *
* @throws Exception
- * DOCUMENT ME!
*/
public <V> V showVisualPropertyValueEditor(Component parentComponent,
VisualProperty<V> type, V initialVal)
- throws Exception;
+ throws Exception;
+
/**
* Display continuous value editor.
*
* <p>
- * Continuous editor always update mapping automatically, so there is no
+ * Continuous editor always update mapping in real-time, so there is no
* return value.
* </p>
- * @param <V> DOCUMENT ME!
- * @param parentComponent DOCUMENT ME!
- * @param type DOCUMENT ME!
- *
- * @throws Exception
- * DOCUMENT ME!
+ *
+ * @param parentComponent parent GUI component
+ * @param type Visual Property to be edited
+ * @throws Exception
*/
- public <V> void showContinuousEditor(Component parentComponent,
VisualProperty<V> type)
- throws Exception;
+ public <V> void showContinuousEditor(Component parentComponent,
VisualProperty<V> type) throws Exception;
+
/**
* Returns the {@link VisualPropertyEditor} for the given {@link
VisualProperty}.
+ *
* @param <V> the generic type of the VisualProperty.
* @param vp the {@link VisualProperty} to get the VisualPropertyEditor
of.
* @return the {@link VisualPropertyEditor} for the given {@link
VisualProperty}.
*/
- public <V> VisualPropertyEditor<V>
getVisualPropertyEditor(VisualProperty<V> vp);
+ <V> VisualPropertyEditor<V> getVisualPropertyEditor(VisualProperty<V>
vp);
/**
- * DOCUMENT ME!
+ * Returns editors for individual cells in discrete mapping editor.
*
- * @return DOCUMENT ME!
+ * @return all available cell editors.
*/
- public List<PropertyEditor> getCellEditors();
+ List<PropertyEditor> getCellEditors();
+ /**
+ * Returns set of selector for available attributes (table columns).
+ *
+ * @return all attribute selectors.
+ */
Collection<PropertyEditor> getAttributeSelectors();
+ /**
+ * Returns selector for Mapping Type. For now, users can select
Discrete, Continuous,
+ * and Passthrough from this object.
+ *
+ * @return mapping type selector.
+ */
PropertyEditor getMappingFunctionSelector();
/**
- * DOCUMENT ME!
- *
- * @param editorName DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Get {@link JComboBox} type editor
+ *
+ * @param editorName name (ID) of editor
+ *
+ * @return combobox editor associated with the name.
*/
- public PropertyEditor getDefaultComboBoxEditor(String editorName);
+ PropertyEditor getDefaultComboBoxEditor(String editorName);
/**
- * DOCUMENT ME!
- * @param targetObjectType DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Attribute selector for the given table entry type.
+ *
+ * @param targetObjectType node, edge, or network.
+ *
+ * @return selector
*/
public PropertyEditor getDataTableComboBoxEditor(final Class<? extends
CyTableEntry> targetObjectType);
+
+ /**
+ * Returns value editor for the given data type.
+ *
+ * @param dataType type of data. They are Color, number, Shape, etc.
+ *
+ * @return Value editor
+ */
public <V> ValueEditor<V> getValueEditor(Class<V> dataType);
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ListEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ListEditor.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ListEditor.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -1,5 +1,19 @@
package org.cytoscape.view.vizmap.gui.editor;
+
+/**
+ * Generic editor for discrete values, such as Shape, Line Type, etc.
+ *
+ * @CyAPI.Spi.Interface
+ *
+ */
public interface ListEditor {
+
+ /**
+ * Type of object managed by this editor.
+ *
+ * @return type of value in this list editor.
+ *
+ */
Class<?> getTargetObjectType();
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/ValueEditor.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -4,9 +4,12 @@
/**
* Provides a GUI Editor for a data type.
+ *
+ * To support new data type, this should be implemented.
*
* @param <V> target data type for this editor.
*
+ * @CyAPI.Spi.Interface
*/
public interface ValueEditor<V> {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/editor/VisualPropertyEditor.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -47,6 +47,8 @@
*
* @param <T> Type of object managed in the Visual Prop.
*
+ * @CyAPI.Spi.Interface
+ *
*/
public interface VisualPropertyEditor<T> {
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedEvent.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedEvent.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedEvent.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -6,7 +6,10 @@
import org.cytoscape.view.model.VisualProperty;
/**
- * #ASKMIKE constructor/method comments
+ * Tell listeners a enabled/disabled visual properties.
+ *
+ * TODO: Refactor dependency mechanism.
+ *
* @CyAPI.Final.Class
*/
public final class LexiconStateChangedEvent extends AbstractCyEvent<Object> {
@@ -14,6 +17,13 @@
private final Set<VisualProperty<?>> enabled;
private final Set<VisualProperty<?>> disabled;
+ /**
+ * Constructor of the event.
+ *
+ * @param source Source of this event.
+ * @param enabled set of Visual Properties to be enabled in the lexicon.
+ * @param disabled set of Visual Properties to be disabled in the
lexicon.
+ */
public LexiconStateChangedEvent(final Object source,
final Set<VisualProperty<?>> enabled,
final Set<VisualProperty<?>> disabled) {
@@ -22,10 +32,20 @@
this.disabled = disabled;
}
+ /**
+ * Get set of Visual Properties to be disabled in the lexicon.
+ *
+ * @return set of lexicon to be disabled
+ */
public Set<VisualProperty<?>> getDisabled() {
return this.disabled;
}
+ /**
+ * Get set of Visual Properties to be enabled in the lexicon.
+ *
+ * @return set of VP to be enabled.
+ */
public Set<VisualProperty<?>> getEnabled() {
return this.enabled;
}
Modified:
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedListener.java
===================================================================
---
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedListener.java
2011-11-15 00:49:08 UTC (rev 27468)
+++
core3/api/trunk/vizmap-gui-api/src/main/java/org/cytoscape/view/vizmap/gui/event/LexiconStateChangedListener.java
2011-11-15 18:53:49 UTC (rev 27469)
@@ -2,6 +2,7 @@
/**
* Listener for {@link LexiconStateChangedEvent}.
+ *
* @CyAPI.Spi.Interface
*/
public interface LexiconStateChangedListener {
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
