Changes between Version 4 and Version 5 of GROUP_TEMPLATES_R1

Timestamp:

05/21/09 17:24:53 (16 years ago)

Author:

jani

Comment:

--

GROUP_TEMPLATES_R1

@@ -31 +31 @@
 
 = Design =
-The goal of this revision is to make the templating library simplier. For example, in the previous revision it was possible 
-to have a derived object with local changes, which greatly increased complexity. 
-Also, instead of having useTemplate() and locked() properties, an enumeration TemplateMode should be introduced, with the following elements:
+
+Instead of having useTemplate() and locked() properties, an enumeration TemplateMode should be introduced, with the following elements:
  * USE_TEMPLATE - the value from the template is used
  * LOCKED - the own value is used and it cannot be modified
  * CUSTOM - the own value is used and it can be modified.
-Also, when setting a value to a mutable object, for instance Frame, it should be set to all children recursevly - for example backgroundStyle(), borderStyle(), contentLocation(), etc.
+
+When setting a value to a mutable object, for instance Frame, it should be set to all children recursevly - for example backgroundStyle(), borderStyle(), contentLocation(), etc.
 Setting a value to a mutable object, actually does not change its mode in its own TemplateSupport - instead it is only changed in the children. This should insure that there cannot be derived mutable objects.
- 
-A new interface Templatable should be added, which contains the templateSupport() property. All classes need template support should implement this interface.
+Here is an example of setting a mode:
+ * {{{frame.templateSupport().get().mode().set(TemplateMode.LOCKED);}}} - this will set all properties of the frame to be in locked mode. Those include all properties of the border style, background style, shadow style, and also, the content location, content size, etc.
+ * {{{frame.backgroundStyle().get().templateSupport().get().mode().set(TemplateMode.LOCKED);}}} - this will lock all the properties of the backgroundStyle.
+ * {{{frame.templateSupport().get().setMode(frame.backgroundStyle(), TemplateMode.LOCKED);}}} - this does the same as above.
+ * {{{frame.templateSupport().get().setMode(frame.contentLocation(), TemplateMode.LOCKED);}}} - this will lock only the location
+Here is an example of getting a mode:
+ * {{{frame.templateSupport().get().getMode(frame.contentLocation());}}} - gets the mode of the location
+ * {{{frame.templateSupport().get().getMode(frame.backgroundStyle());}}} - get the mode of the background style. If all properties of the background style are USE_TEMPLATE (for example), then USE_TEMPLATE is returned. CUSTOM is returned otherwise.
+ * {{{frame.backgroundStyle().get().templateSupport().get().mode().get();}}} - some as the above.
+ * {{{frame.templateSupport().get().mode().get}}} - will return USE_TEMPLATE if the whole frame uses the template, LOCKED if the whole frame is locked, and CUSTOM otherwise.
 
-Class TemplateField should be rafactored in a way that the TemplateMode enumeration is used.
-
-Class TemplateValueField should be refactored in the following way:
- * value() should always return ownValue() if the object is a mutable
- * derivedValue() should only return immutables
- 
-Class TemplateListField should be refactored in a way that either the ownList or derivedList is returned, depending on the mode.
-
-Class TemplateSupport should be rafactored in a way that the TemplateMode enumeration is used.
+The following changes should be considered: 
+ * A new interface Templatable should be added, which contains the templateSupport() property. All classes need template support should implement this interface.
+ * Class TemplateField should be rafactored in a way that the TemplateMode enumeration is used.
+ * Class TemplateValueField should be refactored in the following way:
+  * value() should always return ownValue() if the object is a mutable
+  * derivedValue() should only return immutables
+ * Class TemplateListField should be refactored in a way that either the ownList or derivedList is returned, depending on the mode.
+ * Class TemplateSupport should be rafactored in a way that the TemplateMode enumeration is used.
 
 Updated UML class diagram: