Jump to: navigation, search

Difference between revisions of "Status Colour LED (UBIK Android)"

(→‎See also)
Line 1: Line 1:
−
Status LEDs are shown for objects in the [[UBIK_Client_Basics|{{UBIK}} Android]] client's [[UBIK_Client_Basics#Content_Browser|Content Browser]] classified by the [[SYSCLS_STATUSCOLOR|Status Color classification]].
+
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:
−
The following is UBIK.Android.Kernel's IStatusColorClassification interface describing its UUID and relevant property '''STATUSCOLOR'''.
+
* [[SYSCLS_STATUSCOLOR|Status color classification]]
 +
* [[SYSCLS_OBJECT_WTIH_STATUSICON|Object with status icon classification]]
  
−
The '''STATUSCOLOR''' property has to be an integer property describing the RGB value of the status colour as a decimal number.
+
== 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;
 +
* 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.}}
  
−
<source lang="java">
+
== Status color ==
−
package com.augmensys.ubik.classification.statuscolor;
+
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.
  
−
import java.util.UUID;
+
== UI representation ==
  
−
import com.augmensys.ubik.classification.IClassification;
+
=== Action bar ===
−
import com.augmensys.ubik.model.content.ContentClass;
+
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>
  
−
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 = UUID.fromString("1E84CF6C-CF6D-49B7-8EAF-C013CB384DC5");
+
If the property isn't hidden or write-protected, the LED can be changed by editing the respective property.
−
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 Row
 +
File:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing the Status Color
 +
</gallery>
  
−
public Integer getStatusColor(ContentClass content);
+
== Technical ==
−
}
+
−
</source>
+
  
−
== UI Representation ==
+
=== Status color classification ===
−
In the ContentBrowser's object list (either root list or child list) the status LED is shown for respectively configured objects.
+
Details of the classification UUID and the relevant property STATUSCOLOR can be found [[SYSCLS_STATUSCOLOR|here]].
  
−
If the property isn't hidden or write-protected, the LED can be changed by editing the respective property.
+
The STATUSCOLOR property has to be an integer property describing the RGB value of the status color as a decimal number.
−
The status LED can also be hidden by deleting the value.
+
  
−
<gallery widths="200" heights="200">
+
=== Object with status icon classification ===
−
File:UI_TechSpec_UBIKClient_StatusLed_Appearance.png|Appearance of the Status LED
+
Details of the classification UUID and the relevant property STATUSICONID can be found [[SYSCLS_OBJECT_WTIH_STATUSICON|here]].
−
File:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing the Status Colour
+
 
−
</gallery>
+
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 ==
 
== See also ==
 
* [[HowTo:Make_an_Object_show_a_Status_LED]]
 
* [[HowTo:Make_an_Object_show_a_Status_LED]]
 
* [[HowTo:Customize_Status_LED_on_Mobile_Client]]
 
* [[HowTo:Customize_Status_LED_on_Mobile_Client]]
−
* [[SYSCLS_STATUSCOLOR]]  
+
* [[SYSCLS_STATUSCOLOR]]
 +
* [[SYSCLS_OBJECT_WTIH_STATUSICON]]
 +
* [[SYSCLS_STATUSICON]]
  
−
[[Category:Android]]
+
[[Category:Android|Status Colour LED (UBIK Android)]]

Revision as of 13:24, 17 November 2015

Status LEDs are shown in UBIK® Android client's Content Browser for objects with status information, namely classified by at least one of the following classifications:

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;
  • Otherwise, UBIK® searches for a locally/client configured status icon to display;
  • If none of the above exists, a default icon is displayed.
IC Hint square.pngIf 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.

  • Status LED in Action Bar

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.

  • Status LED in Content Row

  • Editing the Status Color

Technical

Status color classification

Details of the classification UUID and the relevant property STATUSCOLOR can be found 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 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 here.

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

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=Status_Colour_LED_(UBIK_Android)&oldid=17763"