From wiki.ginstr.com
Jump to: navigation, search
m
 
(13 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
[[Category:Action_Library]]
 
[[Category:Action_Library]]
  
<code>[[gn:act_convertTimestampToFormat]]</code> is used to convert timestamp (numerical value) from certain widget to human readable format.  
+
;Description: Action used to convert timestamp (numerical value) from certain widget to human readable format. Action by default formats time in relation to local timezone of user.
  
;Can be used on widgets: any widget
+
;Action returns: void
 +
==Action signatures==
  
;Event trigger for action: no event, must be used in action set or conditional action.
+
===Convert timestamp from certain widget===
  
;Can be used as: a [[:Category:Actions#Action_types|no event action]]
+
:;<code>[gn:act_convertTimestampToFormat]|[source,target,format]</code>
  
;Additional required attributes on bound widget: none
+
with timezone
  
;Additional required attributes on other widgets: none
+
:;<code>[gn:act_convertTimestampToFormat]|[source,target,format,manualTimeZone]</code>
==Action signature==
+
 
;<code>[gn:act_convertTimestampToFormat]|[@+id/sourceWidget,@+id/targetWidget,format]</code>
+
:{| class="wikitable sortable" style="font-size: 85%; text-align: left;"
==Value field content==
+
|-
;<code>sourceWidget</code>: defines widget from which data is retrieved for conversion.
+
! scope="col" | Parameter
:Currently implemented for:
+
! scope="col" | Description
::*<code>[[GnEditText]]</code> – value in <code>[[GnEditText]]</code> must be timestamp
+
|-
;<code>targetWidget</code>: widget into which converted timestamp will be stored.
+
| <code>[[source]]</code>
:Currently implemented for:
+
| [[source]] from where value for conversion will be retrieved
::*<code>[[GnEditText]]</code>
+
* Valid [[source|sources]]:
;<code>format</code>: acceptable formats can be found [http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html here]
+
**<code>[[Datatypes#text|text]]</code>
::i.e. <code>"dd.MM.yyyy hh:mm"</code>
+
**<code>[[Datatypes#date|date]]</code>
 +
**<code>[[Datatypes#dateTime|dateTime]]</code>
 +
**<code>[[Datatypes#time|time]]</code>
 +
**<code>[[Datatypes#number|number]]</code>
 +
|-
 +
| <code>[[target]]</code>
 +
| [[target]] from where the while action is using value as expression comparsion parameter
 +
* Valid [[target|targets]]:
 +
** <code>[[Datatypes#text|text]]</code>
 +
|-
 +
| <code>format</code>
 +
| format in which [[source]] value will be converted
 +
* Valid formats:
 +
**[http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html formats]
 +
|-
 +
| <code>manualTimeZone</code>
 +
| timeZone in which timestamp will be shown. By default it's local timezone. If <code>DATE</code> datatype is used then default timezone is <code>GMT</code>. Valid timezones:
 +
[https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html timezone construct]
 +
* Valid [[target|targets]]:
 +
** <code>[[Datatypes#text|text]]</code>
 +
|-
 +
|}
 +
 
 +
====Example====
 +
:<code>@+id/timeInDATA</code> - [[source]]<br>
 +
:<code>@+id/clockTimeIn</code> - [[target]]<br>
 +
:<code>@string/screen3_timeFormat</code> - format e.g. <code>dd.MM.yyyy H:mm:ss</code><br>
 +
:; ⤷ <code>[gn:act_convertTimestampToFormat]|[@+id/timeInDATA,@+id/clockTimeIn,@string/screen3_timeFormat]</code>
 +
<hr>

Latest revision as of 13:27, 4 November 2020

gn:act_convertTimestampToFormat

Description
Action used to convert timestamp (numerical value) from certain widget to human readable format. Action by default formats time in relation to local timezone of user.
Action returns
void

Action signatures

Convert timestamp from certain widget

[gn:act_convertTimestampToFormat]|[source,target,format]

with timezone

[gn:act_convertTimestampToFormat]|[source,target,format,manualTimeZone]
Parameter Description
source source from where value for conversion will be retrieved
target target from where the while action is using value as expression comparsion parameter
format format in which source value will be converted
manualTimeZone timeZone in which timestamp will be shown. By default it's local timezone. If DATE datatype is used then default timezone is GMT. Valid timezones:

timezone construct

Example

@+id/timeInDATA - source
@+id/clockTimeIn - target
@string/screen3_timeFormat - format e.g. dd.MM.yyyy H:mm:ss
[gn:act_convertTimestampToFormat]|[@+id/timeInDATA,@+id/clockTimeIn,@string/screen3_timeFormat]