<
From version < 63.2 >
edited by Vincent Massol
on 2020/06/09
To version < 63.3 >
edited by Sergei Kulagin
on 2022/11/18
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.VincentMassol
1 +XWiki.Kulagin
Content
... ... @@ -10,7 +10,7 @@
10 10  
11 11  = XWiki Classes, Objects, and Properties =
12 12  
13 -If you are familiar with object oriented programming, you understand the concept of classes, properties, and objects. The presentation level data model that XWiki exposes is much the same.
13 +If you are familiar with object oriented programming, you understand the concept of classes, properties and objects. The presentation level data model that XWiki exposes is much the same.
14 14  
15 15  ; Classes
16 16  : An XWiki class is like a template that defines a unique type of object. It defines what properties an object can have. When you define a custom class, you are saying that your application may need to create one or many objects (instances) of that class. The class itself is like a cookie cutter and the objects are unique instances of that class. So, in this analogy, if the class is the cookie cutter, the objects are the cookies (and we are talking about real edible cookies in this analogy; not Web cookies).
... ... @@ -22,29 +22,29 @@
22 22  
23 23  (((
24 24  |= Field Type|= Since Version |= Description |= Screenshots
25 -|//String//||Allows to store and display one line texts |
26 -|//TextArea//||Allows to store and display large text fields (text and wysiwyg)|
27 -|//Number//||Allows to store and display Numbers of type integer,long,float,double|
28 -|//Password//||Allows to store password fields which can be encrypted or hashed |
25 +|//String//| |Allows to store and display one line texts |
26 +|//TextArea//| |Allows to store and display large text fields (text and wysiwyg)|
27 +|//Number//| |Allows to store and display Numbers of type integer,long,float,double|
28 +|//Password//| |Allows to store password fields which can be encrypted or hashed |
29 29  |//EMail//|4.2M3 |Allows to store email fields that can be obfuscated at display time |
30 -|//Boolean//||Allows to store and display boolean values (yes/no or 1/0) which can be displayed as select or checkbox fields |
31 -|[[//Static List//>>.Static List.WebHome]]||Allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields. The possible values of static list fields are configured in the field definition.
32 -|[[//Database List//>>.DatabaseList.WebHome]]||Allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields. The possible values of database list fields are taken from the execution of a query on other XWiki data such as pages or objects. The query is typically expressed in the Hibernate Query Language (see [[XWiki Query Module>>extensions:Extension.Query Module]]) and it can use [[the Velocity script notation>>Documentation.DevGuide.Scripting.WebHome]] (as long as the XWiki class author has [[the required scripting permission>>extensions:Extension.Security Module]]) for including dynamic parameters such as the current page space, the current time, etc.|{{image reference="dbListSuggestInput.png"/}}
33 -|//Database Tree List//||Same as a Database List field, with the addition that the data can be displayed as a tree, using the Yahoo Javascript Tree library |
30 +|//Boolean//| |Allows to store and display boolean values (yes/no or 1/0) which can be displayed as select or checkbox fields |
31 +|[[//Static List//>>.Static List.WebHome]]| |Allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields. The possible values of static list fields are configured in the field definition.
32 +|[[//Database List//>>.DatabaseList.WebHome]]| |Allows to store and display single-select or multi-select fields that can be displayed as select, checkbox, radio or suggests fields. The possible values of database list fields are taken from the execution of a query on other XWiki data such as pages or objects. The query is typically expressed in the Hibernate Query Language (see [[XWiki Query Module>>extensions:Extension.Query Module]]) and it can use [[the Velocity script notation>>Documentation.DevGuide.Scripting.WebHome]] (as long as the XWiki class author has [[the required scripting permission>>extensions:Extension.Security Module]]) for including dynamic parameters such as the current page space, the current time, etc.|{{image reference="dbListSuggestInput.png"/}}
33 +|//Database Tree List//| |Same as a Database List field, with the addition that the data can be displayed as a tree, using the Yahoo Javascript Tree library |
34 34  |//Page//|4.2M3|Same as a Database List field, but made to store XWiki page names. |(((
35 35  {{image reference="pageSuggestInput.png"/}}
36 36  )))
37 -|//Date//||Allows to store and display date or datetime values. A date picker is used automatically for this field as shown below. |(((
37 +|//Date//| |Allows to store and display date or datetime values. A date picker is used automatically for this field as shown below. |(((
38 38  {{image reference="dateTimePicker.png"/}}
39 39  )))
40 -|//User List//||Allows to store and display single-select or multi-select users. The field uses a user picker as shown below.|(((
40 +|//User List//| |Allows to store and display single-select or multi-select users. The field uses a user picker as shown below.|(((
41 41  {{image reference="userPicker-singleSelection.png"/}}{{image reference="userPicker-multipleSelection.png"/}}{{image reference="userPicker-view.png"/}}
42 42  )))
43 -|//Group List//||Allows to store and display single-select or multi-select groups. The field uses a user picker as shown below.|(((
43 +|//Group List//| |Allows to store and display single-select or multi-select groups. The field uses a user picker as shown below.|(((
44 44  {{image reference="groupPicker-editMultiple.png"/}}
45 45  )))
46 -|//[[Computed Pseudofield]]//|4.2M3|Allows to create a pseudo field for which the display can be configured using a custom displayer and the value retrieved by using a script. It allows to combine other fields together.|
47 -|//Time Zone//|7.3M1|Allow to display and edit Time Zones.|
46 +|//[[Computed Pseudofield]]//|4.2M3|Allows to create a pseudo field for which the display can be configured using a custom displayer and the value retrieved by using a script. It allows to combine other fields together.|
47 +|//Time Zone//|7.3M1|Allow to display and edit Time Zones.|
48 48  
49 49  : Starting with version 4.3M2 you can define [[your own property types>>platform:DevGuide.CreatingNewXClassPropertyTypes]].
50 50  
... ... @@ -66,4 +66,4 @@
66 66  * You could also try using the [[App Within Minutes extension>>extensions:Extension.App Within Minutes Application]] which simplifies how to get started developing an application with little required knowledge. After your application is generated, if you wish to go further and develop new features for your app, you'll need to use your knowledge about Classes, Objects and [[platform:DevGuide.Scripting]].
67 67  * More information on the [[Custom Display field>>xwiki:FAQ.Bindings available inside the Custom Display property]] and an [[example>>snippets:Extension.User Property Custom Display]]
68 68  * A user-written blog post about how to use XWiki's XClass/XObjects for a real use case: [[The Power of XWiki>>https://propaganda-tactics.com/xwiki/bin/view/About/The%20Power%20of%20XWiki/]].
69 -
69 +)))

Get Connected