View source for Status Colour LED (UBIK Android)

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 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.}}

[[Category:Android|Status Colour LED (UBIK Android)]]

== 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.

<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]]

[[Category:Android|Status Colour LED (UBIK Android)]]