Jump to: navigation, search

Difference between revisions of "Object Editor"

 
(29 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==Purpose==
+
The Object Editor is designed to display and edit the [[BaseProperty|properties]] of a single {{UBIK}} object. Technically, it reads the [[MetaProperty]] definition of the context object (directly from the context object if it is of type [[MetaClass]], otherwise it gets the MetaClass of the context object and reads the definition from there).
−
The Object Editor is designed to display and edit the [[BaseProperty|properties]] of a single {{UBIK}} object.
+
 
 +
{{ControlInfoBox
 +
| title = Object Editor
 +
| name = Object Editor
 +
| internalname = CtrlObjectEditor
 +
| image = [[File:UI_ObjectEditor.png|220px]]
 +
| imagecaption = Object Editor control
 +
| purpose = Edit single object data
 +
| context = Any
 +
| version = 2+
 +
}}
  
 
==Basics==
 
==Basics==
Line 6: Line 16:
 
===Appearance===
 
===Appearance===
 
====Property controls====
 
====Property controls====
−
The control reads the property definition from the current context object and displays an editing control according to the respective data type of the [[MetaProperty]]:
+
The control reads the definition from the current context object and displays an editing control for each found property, its appearance depending on the respective data type of the [[MetaProperty]]. In addition, it groups all editing control according to the value of the ''CATEGORY'' property, where each distinctive value will lead to an own tab page within the Object Editor. The following data types and thus different editing controls are currently supported:
  
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
 
|-
 
|-
−
! Data type!! Editing control!! Comment  
+
! Data type!! Example !! Comment  
 
|- align="left"
 
|- align="left"
−
| [[Bool]] || Picture || True or false to be read/set via a Checkbox
+
| Bool || [[File:UI_ObjectEditor_Bool.png|220x140px]] || A [[MetaProperty#Boolean|boolean]] value to be read/set via a Checkbox
 
|- align="left"
 
|- align="left"
−
| [[ByteStream]]|| Picture ||Internal type, will not result in an editing control
+
| DateTime || [[File:UI_ObjectEditor_DateTime.png|220x140px]] || A [[MetaProperty#Date Time|Date/Time]] value where the format is according to regional settings
 
|- align="left"
 
|- align="left"
−
| [[DateTime]] || Picture || Date and time in a combined value; format according to regional settings
+
| Double || - || A [[MetaProperty#Floating Point|floating point]] value, optionally with [[Unit|unit of measurement]]
 
|- align="left"
 
|- align="left"
−
| [[Double]] || Picture || Double-precision floating-point format, optionally with [[Unit|unit]]
+
| FileReference|| - || A [[MetaProperty#File Reference|path to a physical file]]; the button opens a dialog to pick a file from the file system
 
|- align="left"
 
|- align="left"
−
| [[FileReference]]|| Picture || A path to a physical file in [http://en.wikipedia.org/wiki/Path_(computing)#MS-DOS.2FMicrosoft_Windows_style DOS/Windows]- or [http://en.wikipedia.org/wiki/Path_(computing)#Uniform_Naming_Convention UNC] notation
+
| GeoData || [[File:UI_ObjectEditor_GEO.png|220x140px]] || A [[MetaProperty#Geographical Coordinate|geographical coordinate]]; the button tries to open the current value as location in Google maps
 
|- align="left"
 
|- align="left"
−
| [[GeoData]] || Picture || Absolute geographic position combined of Longitude, Latitude and Altitude in [http://en.wikipedia.org/wiki/World_Geodetic_System WGS84] format
+
| Guid || [[File:UI_ObjectEditor_GUID.png|220x140px]] || A [[MetaProperty#Guid|pointer]] to another object
 
|- align="left"
 
|- align="left"
−
| [[Guid]]|| Picture || Pointer to another object, represented with the [http://en.wikipedia.org/wiki/Globally_unique_identifier GUID] of the target object
+
| Int || [[File:UI_ObjectEditor_Int.png|220x140px]] || A [[MetaProperty#Integer|discrete]] number
 
|- align="left"
 
|- align="left"
−
| [[Int]]|| Picture ||
+
| String || [[File:UI_ObjectEditor_String.png|220x140px]] || A [[MetaProperty#Text|text]] value
−
|- align="left"
+
−
| [[String]]|| Picture ||
+
−
|- align="left"
+
−
| [[Undefined]]|| Picture ||Internal type, will not result in an editing control
+
−
|- align="left"
+
−
| [[XML]]|| Picture ||
+
 
|}
 
|}
 +
 +
====Selective lists====
 +
[[File:UI_ObjectEditor_List.png|thumb|220px|String control with enabled list]]
 +
If a certain property has a [[Selective list|selective list]] defined, the respective editing control will display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.
 +
 +
====Index values====
 +
If a certain property has [[Index value|index values]] defined, the respective editing control will become expandable. When expanding, the editing control will multiply itself by the number of index values and present an own editing control for each.
 +
 +
{{Hint|A multilanguage MetaProperty is actually a string property with index values defined for each system language!}}
  
 
====Captions====
 
====Captions====
Line 42: Line 55:
 
* when hovering over the label of an editing control, a Tooltip with the ''NAME'' of the respective MetaProperty will appear
 
* when hovering over the label of an editing control, a Tooltip with the ''NAME'' of the respective MetaProperty will appear
 
* when hovering over a editing control wit a defined [[Unit|unit]] (type double only), a Tooltip will show the current value computed in all other units of the same [[SI-Unit]].
 
* when hovering over a editing control wit a defined [[Unit|unit]] (type double only), a Tooltip will show the current value computed in all other units of the same [[SI-Unit]].
 +
 +
===Editing===
 +
When editing a value, it will only be written back to the respective property when you leave the editing control. At that very point in time, the Object Editor also runs an integrity check and tests if the value you've entered can be stored on the property. If this fails, it will color the respective value <span style="color:red">red</span> and it will not be stored when saving the object. The coloring changes back to normal once you've entered a valid value. If there is also a warning range defined in the validation, the value will be marked with an exclamation mark on <span style="color:orange">yellow</span> background if the value is within the warning range. However, a value showing a warning is a valid input and can be saved as well.
 +
 +
{{Hint| When editing a value, you can use {{key press|Ctrl|Z}} to undo your last change!}}
  
 
===Drag & Drop===
 
===Drag & Drop===
Line 49: Line 67:
 
{| class="wikitable" | width = "50%"
 
{| class="wikitable" | width = "50%"
 
|-
 
|-
−
! Control !! Purpose  
+
! Item !! Purpose  
 
|- align="left"
 
|- align="left"
 
| View Style || Indicates or changes the [[#View Style|View Style]] of the control; changing it will result in reloading of the control  
 
| View Style || Indicates or changes the [[#View Style|View Style]] of the control; changing it will result in reloading of the control  
Line 55: Line 73:
 
| Navigate to context object || Attempts to [[Navigation|navigate]] to the current context MetaClass.
 
| Navigate to context object || Attempts to [[Navigation|navigate]] to the current context MetaClass.
 
|- align="left"
 
|- align="left"
−
| Save || Saves the [[Relation Data|relation data]] object.
+
| Save || Saves the context object.
 
|}
 
|}
  
Line 72: Line 90:
 
==Other functionality==
 
==Other functionality==
  
 +
==See also==
 +
* [[Bulk Editor]]
  
  
−
 
+
[[Category:Studio controls]]
−
[[Category:UBIK Studio Controls]]
+

Latest revision as of 15:33, 2 February 2015

The Object Editor is designed to display and edit the properties of a single UBIK® object. Technically, it reads the MetaProperty definition of the context object (directly from the context object if it is of type MetaClass, otherwise it gets the MetaClass of the context object and reads the definition from there).

Object Editor
UI ObjectEditor.png
Object Editor control
Name Object Editor
Internal Name CtrlObjectEditor
Purpose Edit single object data
Context object Any
Version 2+

Basics

Appearance

Property controls

The control reads the definition from the current context object and displays an editing control for each found property, its appearance depending on the respective data type of the MetaProperty. In addition, it groups all editing control according to the value of the CATEGORY property, where each distinctive value will lead to an own tab page within the Object Editor. The following data types and thus different editing controls are currently supported:

Data type Example Comment
Bool UI ObjectEditor Bool.png A boolean value to be read/set via a Checkbox
DateTime UI ObjectEditor DateTime.png A Date/Time value where the format is according to regional settings
Double - A floating point value, optionally with unit of measurement
FileReference - A path to a physical file; the button opens a dialog to pick a file from the file system
GeoData UI ObjectEditor GEO.png A geographical coordinate; the button tries to open the current value as location in Google maps
Guid UI ObjectEditor GUID.png A pointer to another object
Int UI ObjectEditor Int.png A discrete number
String UI ObjectEditor String.png A text value

Selective lists

String control with enabled list

If a certain property has a Selective list defined, the respective editing control will display a Combobox with all items of the list instead of the value field. The value can then only be selected from the list, but not be edited manually anymore.

Index values

If a certain property has index values defined, the respective editing control will become expandable. When expanding, the editing control will multiply itself by the number of index values and present an own editing control for each.

IC Hint square.pngA multilanguage MetaProperty is actually a string property with index values defined for each system language!

Captions

Per default, each editing control shows the description string (DESCR) of the respective MetaProperty as its caption.

Tooltips

There are two kinds of Tooltips used in this control:

  • when hovering over the label of an editing control, a Tooltip with the NAME of the respective MetaProperty will appear
  • when hovering over a editing control wit a defined Unit (type double only), a Tooltip will show the current value computed in all other units of the same SI-Unit.

Editing

When editing a value, it will only be written back to the respective property when you leave the editing control. At that very point in time, the Object Editor also runs an integrity check and tests if the value you've entered can be stored on the property. If this fails, it will color the respective value red and it will not be stored when saving the object. The coloring changes back to normal once you've entered a valid value. If there is also a warning range defined in the validation, the value will be marked with an exclamation mark on yellow background if the value is within the warning range. However, a value showing a warning is a valid input and can be saved as well.

IC Hint square.png When editing a value, you can use Ctrl+Z to undo your last change!

Drag & Drop

The Object Editor control is a target for Drag&Drop operations, any object can be dropped on the value field of an editing control if the dragged object matches the data type of the respective property.

Toolbar

Item Purpose
View Style Indicates or changes the View Style of the control; changing it will result in reloading of the control
Navigate to context object Attempts to navigate to the current context MetaClass.
Save Saves the context object.

Context menu

This control doesn't feature any context menu yet.

View Styles

The Object Editor has two different View Styles, each of them providing different views and functionality.

List

The control will display the properties in a list, sorted according to the property ORDERID

Layouted

No functionality yet.

Other functionality

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Object_Editor&oldid=11330"