Status LED - Revision history

KNO at 12:07, 2 May 2016

2016-05-02T12:07:48Z

KNO at 16:38, 11 February 2016

2016-02-11T16:38:18Z

KNO at 10:18, 27 January 2016

2016-01-27T10:18:11Z

KNO at 10:07, 27 January 2016

2016-01-27T10:07:49Z

NWE: /* Changing the icon or the colour */

2015-11-27T18:09:01Z

‎Changing the icon or the colour

NWE: /* UI representation */

2015-11-27T18:08:18Z

‎UI representation

NWE: /* UI representation */

2015-11-27T18:07:38Z

‎UI representation

NWE: /* Action bar */

2015-11-27T17:31:31Z

‎Action bar

LGE: Created page with "Status LEDs are shown in {{UBIK}} Android client's Content Browser for objects with status information, namely cl..."

2015-11-17T13:55:02Z

Created page with "Status LEDs are shown in {{UBIK}} Android client's Content Browser for objects with status information, namely cl..."

New page

Status LEDs are shown in [[UBIK_Client_Basics|{{UBIK}} Android]] client's [[UBIK_Client_Basics#Content_Browser|Content Browser]] for objects with status information, namely classified by at least one of the following classifications:
* [[SYSCLS_STATUSCOLOR|Status color classification]]
* [[SYSCLS_OBJECT_WTIH_STATUSICON|Object with status icon classification]]

== Status icon ==
The status LED is essentially a status icon image with different coloring. Which icon to display is determined in the following way.
* It there is a server configured status icon for an object (namely the object is classified by the object with status icon classification), that icon is displayed as the status LED; ({{Version/AndroidSince|2.5.1}})
* Otherwise, {{UBIK}} searches for a [[HowTo:Customize_Status_LED_on_Mobile_Client|locally/client configured status icon]] to display;
* If none of the above exists, a default icon is displayed.
{{Hint|If the server configured icon is corrupted for some reason (e.g. not delivered from the server correctly), the status led will try to display the client configured icon or the default one.}}

== Status color ==
If an object is classified by the status color classification and has a valid status color, the color value is used to colorize/tint the icon displayed in the status LED. Otherwise, the icon will be displayed in its original color.

== UI representation ==

=== Action bar ===
When the currently browsed object has status information, a status LED is shown after the object's description text in the action bar. ({{Version/AndroidSince|2.5.1}})

<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_InActionBar.png|Status LED in Action Bar
</gallery>

=== Object list ===
In the ContentBrowser's object list (either root list or child list) the status LED is shown for respectively configured objects.

If the property isn't hidden or write-protected, the LED can be changed by editing the respective property.

<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_Appearance.png|Status LED in Content Row
File:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing the Status Color
</gallery>

== Technical ==

=== Status color classification ===
Details of the classification UUID and the relevant property STATUSCOLOR can be found [[SYSCLS_STATUSCOLOR|here]].

The STATUSCOLOR property has to be an integer property describing the RGB value of the status color as a decimal number.

=== Object with status icon classification ===
Details of the classification UUID and the relevant property STATUSICONID can be found [[SYSCLS_OBJECT_WTIH_STATUSICON|here]].

The STATUSICONID property has to contain the Guid of an object classified by the status icon classification.

=== Status icon classification ===
Details of the classification UUID and the relevant property STATUSICON can be found [[SYSCLS_STATUSICON|here]].

The STATUSICON property has to contain the byte stream of the icon image.

== See also ==
* [[HowTo:Make_an_Object_show_a_Status_LED]]
* [[HowTo:Customize_Status_LED_on_Mobile_Client]]
* [[SYSCLS_STATUSCOLOR]]
* [[SYSCLS_OBJECT_WTIH_STATUSICON]]
* [[SYSCLS_STATUSICON]]

@@ Line 5: / Line 5: @@
 == Status icon ==
 The status LED is essentially a status icon image with different coloring. Which icon to display is determined in the following way.
-* It there is a server configured status icon for an object (namely the object is classified by the object with status icon classification), that icon is displayed as the status LED; ({{Version/AndroidSince|2.5.1}})
+* It there is a server configured status icon for an object (namely the object is classified by the object with status icon classification), that icon is displayed as the status LED; {{Version/AndroidSince|2.5.1}}
 * Otherwise, {{UBIK}} searches for a [[HowTo:Customize_Status_LED_on_Mobile_Client|locally/client configured status icon]] to display;
 * If none of the above exists, a default icon is displayed.
@@ Line 16: / Line 16: @@
 === Action bar ===
-When the currently browsed object has status information, a status LED is shown as an overlay on the content icon in the action bar. ({{Version/AndroidSince|2.5.1}})
+When the currently browsed object has status information, a status LED is shown as an overlay on the content icon in the action bar. {{Version/AndroidSince|2.5.1}}
 <gallery widths="300" heights="200">
@@ Line 67: / Line 67: @@
 {{Category/Version|2.5.1}}
 [[Category:Android|Status LED]]
 [[Category:Client|Status LED]]

@@ Line 64: / Line 64: @@
 * [[SYSCLS_OBJECT_WTIH_STATUSICON]]
 * [[SYSCLS_STATUSICON]]
 [[Category:Android|Status LED]]
 [[Category:Client|Status LED]]

← Older revision		Revision as of 10:18, 27 January 2016
Line 65:		Line 65:
	* [[SYSCLS_STATUSICON]]		* [[SYSCLS_STATUSICON]]

−	~~[[Category:Client\|Status LED]]~~
	[[Category:Android\|Status LED]]		[[Category:Android\|Status LED]]
		+	[[Category:Client\|Status LED]]

← Older revision		Revision as of 10:07, 27 January 2016
Line 64:		Line 64:
	* [[SYSCLS_OBJECT_WTIH_STATUSICON]]		* [[SYSCLS_OBJECT_WTIH_STATUSICON]]
	* [[SYSCLS_STATUSICON]]		* [[SYSCLS_STATUSICON]]
		+
		+	[[Category:Client\|Status LED]]
		+	[[Category:Android\|Status LED]]

@@ Line 31: / Line 31: @@
 === Changing the icon or the colour ===
-If the property isn't hidden or write-protected, the LED can be changed by editing the respective property.
+If the property isn't hidden or write-protected, the colour can be changed by editing the respective property.
 Same goes for the actual icon.

@@ Line 21: / Line 21: @@
 File:UI_TechSpec_UBIKClient_StatusLed_InActionBar.png|Status LED in Action Bar
 </gallery>
 === Object list ===