Difference between revisions of "Extensions.HMI.CloseScreen"

From emotive
Jump to navigation Jump to search
Line 1: Line 1:
 
{{DISPLAYTITLE:  '''CloseScreen'''}}[[Category:HMI]]
 
{{DISPLAYTITLE:  '''CloseScreen'''}}[[Category:HMI]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity | CloseScreen | Dismisses screen and release all associated resources | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Custom screen related actions]] | - | - }}
+
{{ClassificationActivity | CloseScreen | Dismisses screen and release all associated resources | [[Action]]| [[Extensions.HMI|OTX HMI extension]] | [[Extensions.HMI#Actions|Custom screen related actions]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
Hmi.CloseScreen(ScreenHandle);
+
HMI.CloseScreen(ScreenVariable);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
The '''CloseScreen''' activity causes the runtime system to ''screen'' and dismiss all resources can, with the ''screen'' connected. After images this activity is the ''screen'' not send more events to process the OTX sequence and may no longer be carried out interaction with the user.
+
The '''CloseScreen''' activity shall cause the runtime system to dismiss the ''screen'' and release all resources associated to the ''screen''.
 +
 
 +
After the execution of the '''CloseScreen''' action, the screen shall not send any more events for processing to the OTX sequence and shall not allow any more user interaction to be performed.
 +
 
 +
Closing an uninitialized or already closed screen shall perform no operation and report no errors. It shall be for all effects a NOP.
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Screen | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [1] | The handle of the screen that to be closed.}}
+
{{TableRowPropertie1| Screen | [[Extensions.HMI.Screen|Screen]] | [[Variable]] | - | [1] | This element represents the screen handle of the screen that shall be closed.}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
package Hmi.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
+
package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);
 +
 
 +
/// Global Declarations
  
 
public procedure main()
 
public procedure main()
 
{
 
{
  Hmi.Screen ScreenHandle1;
+
/// Local Declarations
  Integer ScreenInOut1;
+
 
 +
HMI.Screen ScreenHandle1;
 +
Integer Integer1;
 +
 
 +
/// Flow
  
  Hmi.OpenScreen(ScreenSignature1, false, {ref ScreenInOutParameter1 = ScreenInOut1}, ScreenHandle1);
+
HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
  Hmi.CloseScreen(ScreenHandle1);
+
HMI.CloseScreen(ScreenHandle1);
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 08:16, 28 September 2018

Classification

Name CloseScreen
Short Description Dismisses screen and release all associated resources
Class Action
Extension OTX HMI extension
Group Custom screen related actions
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

HMI.CloseScreen(ScreenVariable);

Description

The CloseScreen activity shall cause the runtime system to dismiss the screen and release all resources associated to the screen.

After the execution of the CloseScreen action, the screen shall not send any more events for processing to the OTX sequence and shall not allow any more user interaction to be performed.

Closing an uninitialized or already closed screen shall perform no operation and report no errors. It shall be for all effects a NOP.

Properties

Name Data Type Class Default Cardinality Description
Screen Screen Variable - [1] This element represents the screen handle of the screen that shall be closed.

OTL Examples

package HMI.ScreenSignature ScreenSignature1(ref Integer ScreenInOutParameter1);

/// Global Declarations

public procedure main()
{
	/// Local Declarations

	HMI.Screen ScreenHandle1;
	Integer Integer1;

	/// Flow

	HMI.OpenScreen(ScreenHandle1, ScreenSignature1, {ScreenInOutParameter1 = Integer1}, false);
	HMI.CloseScreen(ScreenHandle1);
}

See also

OpenScreen
HighlightScreen