Jump to: navigation, search

Changes


Status Colour LED (UBIK Android)

1,347 bytes added, 13:24, 17 November 2015
Status LEDs are shown for objects in the [[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 color classification]].The following is UBIK.Android.Kernel's IStatusColorClassification interface describing its UUID and relevant property '''STATUSCOLOR'''.* [[SYSCLS_OBJECT_WTIH_STATUSICON|Object with status icon classification]]
== Status icon ==The '''STATUSCOLOR''' property has status LED is essentially a status icon image with different coloring. Which icon to be display is determined in the following way.* It there is a server configured status icon for an integer property describing object (namely the RGB value of object is classified by the object with status colour icon classification), that icon is displayed as the status LED;* Otherwise, {{UBIK}} searches for a decimal numberlocally/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.}}
<source lang="java">= Status color ==package com.augmensys.ubik.If an object is classified by the status color classificationand 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.statuscolor;
import java.util.UUID;== UI representation ==
import com.augmensys.ubik.classification.IClassification;=== Action bar ===import com.augmensys.ubik.model.contentWhen the currently browsed object has status information, a status LED is shown after the object's description text in the action bar.ContentClass;
<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_InActionBar.png|Status LED in Action Bar
</gallery>
public interface IStatusColorClassification extends IClassification {=== Object list ===In the ContentBrowser's object list (either root list or child list) the status LED is shown for respectively configured objects.
public static final UUID STATUS_COLOUR_CLASSIFICATION_UID = UUIDIf the property isn't hidden or write-protected, the LED can be changed by editing the respective property.fromString("1E84CF6C-CF6D-49B7-8EAF-C013CB384DC5"); public static final String STATUS_COLOUR_PROPERTY_NAME = "STATUSCOLOR";
public boolean hasStatusColour(ContentClass content);<gallery widths="300" heights="200">File:UI_TechSpec_UBIKClient_StatusLed_Appearance.png|Status LED in Content RowFile:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing the Status Color</gallery>
public Integer getStatusColor(ContentClass content);}</source>== Technical ==
== UI Representation = Status color classification ===In Details of the ContentBrowser's object list (either root list or child list) classification UUID and the status LED is shown for respectively configured objectsrelevant property STATUSCOLOR can be found [[SYSCLS_STATUSCOLOR|here]].
If the The STATUSCOLOR property isn't hidden or write-protected, the LED can has to be changed by editing the respective an integer property.The status LED can also be hidden by deleting describing the RGB valueof the status color as a decimal number.
<gallery widths="200" heights="200">= Object with status icon classification ===File:UI_TechSpec_UBIKClient_StatusLed_Appearance.pngDetails of the classification UUID and the relevant property STATUSICONID can be found [[SYSCLS_OBJECT_WTIH_STATUSICON|Appearance here]]. The STATUSICONID property has to contain the Guid of an object classified by the status icon classification. === Status LEDicon classification ===File:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing Details of the Status Colourclassification UUID and the relevant property STATUSICON can be found [[SYSCLS_STATUSICON|here]].</gallery>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)]]