summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Drossel2008-08-14 10:02:16 (EDT)
committerCarsten Drossel2008-08-14 10:02:16 (EDT)
commit1b0fe76c1bb3a2d873cc88594598633270655a03 (patch)
tree92a54c692baf7251e2a8c288c2e0b81a791e76e1
parent40631f3e0fe90814e433d82b032666f0a707b872 (diff)
downloadorg.eclipse.riena-1b0fe76c1bb3a2d873cc88594598633270655a03.zip
org.eclipse.riena-1b0fe76c1bb3a2d873cc88594598633270655a03.tar.gz
org.eclipse.riena-1b0fe76c1bb3a2d873cc88594598633270655a03.tar.bz2
Javadoc
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationProcessor.java56
-rw-r--r--org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/model/NavigationProcessor.java4
2 files changed, 54 insertions, 6 deletions
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationProcessor.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationProcessor.java
index 191e404..c3cb31e 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationProcessor.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/INavigationProcessor.java
@@ -10,7 +10,6 @@
*******************************************************************************/
package org.eclipse.riena.navigation;
-
/**
* Manages the Navigation. Is called by a navigation node to navigate to it The
* navigation processor works with the INavigationNode What does the navigation
@@ -20,19 +19,68 @@ package org.eclipse.riena.navigation;
*/
public interface INavigationProcessor extends INavigationHistory, INavigationHistoryListernable {
+ /**
+ * Activates a node. Checks which other nodes have to be activated or
+ * deactivated before this node can be activated and calls the
+ * allowsDeactivate() and allowsActivate() methods.
+ *
+ * @see INavigationNode#activate()
+ * @see INavigationNode#allowsActivate(INavigationContext)
+ * @see INavigationNode#deactivate(INavigationContext)
+ * @see INavigationNode#allowsDeactivate(INavigationContext)
+ * @param toActivate
+ * The node to activate.
+ */
void activate(INavigationNode<?> toActivate);
+ /**
+ * Disposes a node. Checks which other nodes have to be disposed (children
+ * and maybe parents it the node is their only child) and calls the
+ * allowsDispose() methods.
+ *
+ * @see INavigationNode#dispose()
+ * @see INavigationNode#allowsDeactivate(INavigationContext)
+ * @param toActivate
+ * The node to dispose.
+ */
void dispose(INavigationNode<?> toDispose);
+ /**
+ * Creates the specified navigation node and adds it to the application
+ * model if does not already exist.
+ *
+ * @param sourceNode
+ * An existing node in the application model tree.
+ * @param targetId
+ * ID of the node to create. Also refers to an extension point
+ * used to create the target node if it does not exist.
+ * @see INavigationNodeBuilder
+ */
void create(INavigationNode<?> sourceNode, INavigationNodeId targetId);
+ /**
+ * Navigates from the specified source node to the specified target node.
+ * The target node is created and added to the application model if no node
+ * with the specified id exists.
+ *
+ * @param sourceNode
+ * The source node.
+ * @param targetId
+ * ID of the target node. Also refers to an extension point used
+ * to create the target node if it does not exist.
+ * @param argument
+ * Contains information passed on to the target node and/or used
+ * during its creation.
+ * @see INavigationNodeBuilder
+ */
void navigate(INavigationNode<?> sourceNode, INavigationNodeId targetId, NavigationArgument argument);
/**
- * Navigates to the caller (the source node) of the given targetNode.
+ * Undoes the last navigate to the specified target node i.e. activates the
+ * last source node of a navigate(..)-call that lead to the activation of
+ * the target node.
*
- * @param targetNode
- * The node where we have navigate to and return from
+ * @see #navigate(INavigationNode, INavigationNodeId, NavigationArgument)
*/
void navigateBack(INavigationNode<?> targetNode);
}
diff --git a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/model/NavigationProcessor.java b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/model/NavigationProcessor.java
index b53800e..eb55bd0 100644
--- a/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/model/NavigationProcessor.java
+++ b/org.eclipse.riena.navigation/src/org/eclipse/riena/navigation/model/NavigationProcessor.java
@@ -180,8 +180,8 @@ public class NavigationProcessor implements INavigationProcessor, INavigationHis
/**
* @see org.eclipse.riena.navigation.INavigationProcessor#navigate(org.eclipse.riena.navigation.INavigationNode,
- * org.eclipse.riena.navigation.INavigationNodeId, java.lang.Object,
- * org.eclipse.riena.navigation.INavigationArgumentListener)
+ * org.eclipse.riena.navigation.INavigationNodeId,
+ * org.eclipse.riena.navigation.NavigationArgument)
*/
public void navigate(INavigationNode<?> sourceNode, INavigationNodeId targetId, NavigationArgument argument) {
INavigationNode<?> targetNode = provideNode(sourceNode, targetId, argument);