SVGHMI: rework Jump widget to cope with Enable Expressions.
Relative jumps are not disabled implicitely anymore when pointed HMI_NODE is 0.
Also, "activable()" implementation was enhanced to make it optional.
// widget_jump.ysl2
widget_desc("Jump") {
longdesc
||
Jump widget brings focus to a different page. Mandatory first argument
gives name of the page.
If first path is pointint to HMI_NODE variable is used as new reference
when jumping to a relative page.
Additional arguments are unordered options:
- Absolute: force page jump to be not relative even if first path is of type HMI_NODE
- name=value: Notify jump by setting variable with path having same name assigned
"active"+"inactive" labeled elements can be provided and reflect current
page being shown.
Exemples:
Relative jump:
HMI:Jump:RelativePage@/PUMP9
HMI:Jump:RelativePage@/PUMP9@role=.userrole#role=="admin"
Absolute jump:
HMI:Jump:AbsolutePage
HMI:Jump:AbsolutePage@role=.userrole#role=="admin"
Forced absolute jump:
HMI:Jump:AbsolutePage:Absolute@/PUMP9
HMI:Jump:AbsolutePage:Absolute:notify=1@notify=/PUMP9
||
shortdesc > Jump to given page
arg name="page" accepts="string" > name of page to jump to
path name="reference" count="optional" accepts="HMI_NODE" > reference for relative jump
}
widget_class("Jump") {
||
activable = false;
active = false;
frequency = 2;
update_activity() {
this.set_activation_state(this.active);
}
update_disability() {
this.animate_enable();
if(this.enable_state) {
this.update_activity();
}
}
make_on_click() {
let that = this;
const name = this.args[0];
return function(evt){
/* TODO: in order to allow jumps to page selected through for exemple a dropdown,
support path pointing to local variable whom value
would be an HMI_TREE index and then jump to a relative page not hard-coded in advance */
if(that.enable_state) {
const index = (that.is_relative && that.indexes.length > 0) ? that.indexes[0] + that.offset : undefined;
fading_page_switch(name, index);
}
}
}
notify_page_change(page_name, index) {
if(this.activable) {
const ref_index = this.indexes.length > 0 ? this.indexes[0] + this.offset : undefined;
const ref_name = this.args[0];
this.active = ((ref_name == undefined || ref_name == page_name) && index == ref_index);
this.update_state();
}
}
animate() {
this.update_state();
}
||
}
def "func:is_relative_jump" {
param "widget";
result "$widget/path and $widget/path[1]/@type='HMI_NODE' and not($widget/arg[position()>1 and @value = 'Absolute'])";
}
widget_defs("Jump") {
optional_activable();
const "jump_disability","$has_activity and $has_disability";
| init: function() {
| this.element.onclick = this.make_on_click();
if "$has_activity" {
| this.activable = true;
}
> this.update_state =
choose {
when "$jump_disability" {
> this.update_disability
}
when "$has_activity" {
> this.update_activity
}
otherwise > function(){}
}
> ;\n
> this.is_relative =
choose{
when "func:is_relative_jump(.)" > true
otherwise > false
}
> ;\n
| },
}
widget_page("Jump"){
param "page_desc";
/* jump is considered relative jump if first path points to HMI_NODE
but a jump can be forced Absolute by adding a "Absolute" argument */
if "func:is_relative_jump(.)" {
/* if relative check that given path is compatible with page's reference path */
/* when no page name provided, check for same page */
const "target_page_name" choose {
when "arg" value "arg[1]/@value";
otherwise value "$page_desc/arg[1]/@value";
}
const "target_page_path" choose {
when "arg" value "$hmi_pages_descs[arg[1]/@value = $target_page_name]/path[1]/@value";
otherwise value "$page_desc/path[1]/@value";
}
if "not(func:same_class_paths($target_page_path, path[1]/@value))"
error > Jump id="«@id»" to page "«$target_page_name»" with incompatible path "«path[1]/@value» (must be same class as "«$target_page_path»")
}
}
/* TODO: move to detachable pages ysl2 */
emit "cssdefs:jump"
||
.fade-out-page {
animation: cubic-bezier(0, 0.8, 0.6, 1) fadeOut 0.6s both;
}
@keyframes fadeOut {
0% { opacity: 1; }
100% { opacity: 0; }
}
||
emit "declarations:jump"
||
var jumps_need_update = false;
var jump_history = [[default_page, undefined]];
function update_jumps() {
page_desc[current_visible_page].jumps.map(w=>w.notify_page_change(current_visible_page,current_page_index));
jumps_need_update = false;
};
||