summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Drossel2008-08-12 12:17:58 (EDT)
committerCarsten Drossel2008-08-12 12:17:58 (EDT)
commit7639c27bd33b4a6a6dbb9ace4fd2d7cb29d3c103 (patch)
treeac595a24ce45538120f5b2c681b4bdc86e45ed93
parentc6d1fae5c17b00e107029368d45a902db667b750 (diff)
downloadorg.eclipse.riena-7639c27bd33b4a6a6dbb9ace4fd2d7cb29d3c103.zip
org.eclipse.riena-7639c27bd33b4a6a6dbb9ace4fd2d7cb29d3c103.tar.gz
org.eclipse.riena-7639c27bd33b4a6a6dbb9ace4fd2d7cb29d3c103.tar.bz2
added documentation
-rw-r--r--org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.NavigationNodeType.exsd11
-rw-r--r--org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.SubModuleType.exsd13
2 files changed, 17 insertions, 7 deletions
diff --git a/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.NavigationNodeType.exsd b/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.NavigationNodeType.exsd
index 4f8f83c..d69fde6 100644
--- a/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.NavigationNodeType.exsd
+++ b/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.NavigationNodeType.exsd
@@ -48,18 +48,23 @@
</element>
<element name="navigationNodeType">
+ <annotation>
+ <documentation>
+ Defines how to create a node or a subtree in the application model tree.
+ </documentation>
+ </annotation>
<complexType>
<attribute name="typeId" type="string" use="required">
<annotation>
<documentation>
-
+ Type part of the ID of the nodes created with this definition. When a subtree is defined it is the type ID of the root node.
</documentation>
</annotation>
</attribute>
<attribute name="nodeBuilder" type="string" use="required">
<annotation>
<documentation>
-
+ A node builder that creates a node or a subtree for the application model tree.
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn=":org.eclipse.riena.navigation.INavigationNodeBuilder"/>
@@ -69,7 +74,7 @@
<attribute name="parentTypeId" type="string">
<annotation>
<documentation>
-
+ ID of the parent indicating where to insert a node or subtree created with this definition in the application model tree.
</documentation>
</annotation>
</attribute>
diff --git a/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.SubModuleType.exsd b/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.SubModuleType.exsd
index 58acd07..697b42a 100644
--- a/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.SubModuleType.exsd
+++ b/org.eclipse.riena.navigation/schema/org.eclipse.riena.navigation.SubModuleType.exsd
@@ -48,25 +48,30 @@
</element>
<element name="subModuleType">
+ <annotation>
+ <documentation>
+ Defines how an activated submodule appears in the work area.
+ </documentation>
+ </annotation>
<complexType>
<attribute name="typeId" type="string" use="required">
<annotation>
<documentation>
-
+ Type part of the ID of the submodule node.
</documentation>
</annotation>
</attribute>
<attribute name="shared" type="boolean" use="default" value="false">
<annotation>
<documentation>
-
+ Indicates whether the view is shared i.e. whether one instance of the view should be used for all submodule instances. Even for a shared view an individual controller instance will be created for each submodule node with its own set of ridgets. The default value is &quot;false&quot;.
</documentation>
</annotation>
</attribute>
<attribute name="controller" type="string">
<annotation>
<documentation>
-
+ A controller that controlles the UI widgets in the view through ridgets (see org.eclipse.riena.ui.ridgets.IRidget)
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn=":org.eclipse.riena.ui.ridgets.viewcontroller.IViewController"/>
@@ -76,7 +81,7 @@
<attribute name="view" type="string">
<annotation>
<documentation>
-
+ For the SWT-based Riena UI this is the ID of the view associated with the submodule. Must match the ID field of an &quot;org.eclipse.ui.view&quot; extension.
</documentation>
<appinfo>
<meta.attribute kind="java" basedOn="java.lang.Object:"/>