summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Drossel2008-08-13 11:18:13 (EDT)
committerCarsten Drossel2008-08-13 11:18:13 (EDT)
commit4f88805f0e9e3c5659c44abaa334011239242946 (patch)
treea324673b6fd2f14497a19f2ee06ee604dee30b6e
parent41b63fd6e5d39616d00e22acc652f7184bbe9fd7 (diff)
downloadorg.eclipse.riena-4f88805f0e9e3c5659c44abaa334011239242946.zip
org.eclipse.riena-4f88805f0e9e3c5659c44abaa334011239242946.tar.gz
org.eclipse.riena-4f88805f0e9e3c5659c44abaa334011239242946.tar.bz2
Javadoc
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationArgumentListener.java12
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationNodeTypeDefiniton.java13
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ISubModuleTypeDefinition.java24
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ITypeDefinition.java8
4 files changed, 32 insertions, 25 deletions
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationArgumentListener.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationArgumentListener.java
index 526319a..98a76a5 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationArgumentListener.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationArgumentListener.java
@@ -11,10 +11,20 @@
package org.eclipse.riena.navigation;
/**
- *
+ * Listener for changes performed on an argument Object that was passed to
+ * another node as part of an NavigationArgument during a navigation.
+ *
+ * @see INavigationNode#navigate(INavigationNodeId, NavigationArgument)
*/
public interface INavigationArgumentListener {
+ /**
+ * Called when the Object passed as an argument during a navigation was
+ * changed.
+ *
+ * @param argument
+ * The changed argument.
+ */
void valueChanged(Object argument);
}
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationNodeTypeDefiniton.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationNodeTypeDefiniton.java
index 2a922da..fc0652a 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationNodeTypeDefiniton.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationNodeTypeDefiniton.java
@@ -11,22 +11,21 @@
package org.eclipse.riena.navigation;
/**
- * A modulePresentationDefinition defines the navigationModule to be activated.
- *
- * @author Erich Achilles
+ * Interface for a NavigationNodeType extension that defines how to create a
+ * node or a subtree in the application model tree.
*/
public interface INavigationNodeTypeDefiniton extends ITypeDefinition {
/**
- * Returns the ModuleComposer for this module presentation
+ * @return A node builder that creates a node or a subtree for the
+ * application model tree.
*/
-
INavigationNodeBuilder createNodeBuilder();
/**
- * The id of this presentations parent presentation
+ * @return ID of the parent indicating where to insert a node or subtree
+ * created with this definition in the application model tree.
*/
-
String getParentTypeId();
}
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ISubModuleTypeDefinition.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ISubModuleTypeDefinition.java
index 9cf7806..1e0c805 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ISubModuleTypeDefinition.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ISubModuleTypeDefinition.java
@@ -15,30 +15,30 @@ import org.eclipse.riena.ui.ridgets.viewcontroller.IViewController;
import org.osgi.framework.Bundle;
/**
- * A WorkAreaPresentationDefinition defines the work area to be activated.
- *
- * @author Erich Achilles
+ * Interface for a SubModuleType extension that defines how an activated
+ * submodule appears in the work area.
*/
public interface ISubModuleTypeDefinition extends ITypeDefinition {
/**
- * Returns the view controller for this SubModuleType
+ * @return A controller that controlles the UI widgets in the view through
+ * ridgets (see org.eclipse.riena.ui.ridgets.IRidget)
*/
IViewController createController();
/**
- * Returns the view controller name
- */
- String getController();
-
- /**
- * Return true if the specified view should be a shared view, false
- * otherwise
+ * Indicates whether the view is shared i.e. whether one instance of the
+ * view should be used for all submodule instances.
+ *
+ * @return true if the specified view should be a shared view, false
+ * otherwise
*/
boolean isShared();
/**
- * Return an view name
+ * @return For the SWT-based Riena UI this is the ID of the view associated
+ * with the submodule. Must match the ID field of an
+ * "org.eclipse.ui.view" extension.
*/
String getView();
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ITypeDefinition.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ITypeDefinition.java
index 537bc99..c61131a 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ITypeDefinition.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/ITypeDefinition.java
@@ -11,15 +11,13 @@
package org.eclipse.riena.navigation;
/**
- * Base interface for presentation definitions, carries the ID
- *
- * @author Erich Achilles
+ * Base interface for type definitions.
*/
public interface ITypeDefinition {
/**
- * The id of this presentation
+ * @return The type part of the ID of a navigation node.
+ * @see INavigationNodeId#getTypeId()
*/
-
String getTypeId();
}