OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation Class Reference

Default custom screen implementation. More...

Inheritance diagram for OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation:

Public Member Functions
void	CloseAll (IRuntimeContext runtimeContext)
	All screens related to the IRuntimeContext which are still open should be closed. More...
void	CloseScreen (IScreenHandle screen)
	Invoked when a CloseScreen occurs in OTX-Runtime. More...
void	HighlightScreen (IScreenHandle screen)
	Invoked when a HighlightScreen occurs in OTX-Runtime. More...
void	OpenScreen (IRuntimeContext runtimeContext, IScreenHandle screenHandle, List< IScreenParameter > parameters, boolean modal)
	Invoked when an OpenScreen occurs in OTX-Runtime. More...
void	RefreshHmiScreen ()
	Refreshes all screens of the Assembly-Screen Implementation. More...
boolean	ScreenIsOpen (IScreenHandle screen)
	Invoked when a ScreenIsOpen occurs in OTX-Runtime. More...
void	SetHmiScreenHandle (long hmiScreenHandle)
	Sets a HWND where screens of the Assembly-Screen Implementation will be displayed. More...
void	StartHtmlWebServer ()
	Start html Webserver when starting HtmlScreen binding.
void	StartHtmlWebServer (String configFilePath)
	Start html Webserver when starting HtmlScreen binding with optional configFilePath. More...
void	StopHtmlWebServer ()
	Stop html Webserver.
void	UpdateScreenParameterValues (IScreenHandle screen, List< String > parameterNames, Object value)
	Invoked when one or more ScreenParameters was changed in OTX-Runtime to the same value. More...

Detailed Description

Default custom screen implementation.

Member Function Documentation

CloseAll()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.CloseAll ( IRuntimeContext  runtimeContext )

inline

All screens related to the IRuntimeContext which are still open should be closed.

Parameters

runtimeContext

The related runtime context.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

CloseScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.CloseScreen ( IScreenHandle  screen )

inline

Invoked when a CloseScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

HighlightScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.HighlightScreen ( IScreenHandle  screen )

inline

Invoked when a HighlightScreen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

OpenScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.OpenScreen ( IRuntimeContext  runtimeContext, IScreenHandle  screenHandle, List< IScreenParameter >  parameters, boolean  modal  )

inline

Invoked when an OpenScreen occurs in OTX-Runtime.

Parameters

runtimeContext	The related runtime context.
screenHandle
parameters	Arguments which are passed to OpenScreen.
modal	If modal is false, the OTX execution flow will immediately move on to the next Action, without waiting for the screen to close. If modal is true, the screen implementation must wait until the screen was closed. Please note, that this behavior must be implemented inside the screen implementation.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

RefreshHmiScreen()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.RefreshHmiScreen ( )

inline

Refreshes all screens of the Assembly-Screen Implementation.

Remarks

Important: The method is not part of OTX HMI extension and is only valid for Assembly-Screen Implementation!

ScreenIsOpen()

boolean OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.ScreenIsOpen ( IScreenHandle  screen )

inline

Invoked when a ScreenIsOpen occurs in OTX-Runtime.

Parameters

screen

Represents a screen instance.

Returns

True if the screen is Open. Otherwise, false.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

SetHmiScreenHandle()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.SetHmiScreenHandle ( long  hmiScreenHandle )

inline

Sets a HWND where screens of the Assembly-Screen Implementation will be displayed.

Parameters

hmiScreenHandle

Hmi screen handle

StartHtmlWebServer()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.StartHtmlWebServer ( String  configFilePath )

inline

Start html Webserver when starting HtmlScreen binding with optional configFilePath.

Parameters

configFilePath

Optional path to web server configuration file. The path must address a JSON file with a valid web server configuration. If not set the file [UserPublic]/OpenTestSystem/HtmlScreen/config.json will be used

UpdateScreenParameterValues()

void OpenTestSystem.Otx.Runtime.Api.Custom.DefaultCustomScreenImplementation.UpdateScreenParameterValues ( IScreenHandle  screen, List< String >  parameterNames, Object  value  )

inline

Invoked when one or more ScreenParameters was changed in OTX-Runtime to the same value.

Parameters

screen	Represents a screen instance.
parameterNames	Names of the parameters which value was changed.
value	Value to all listed parameters was changed.

Implements OpenTestSystem.Otx.Runtime.Api.Custom.ICustomScreenImplementation.

---

The documentation for this class was generated from the following file:

• DefaultCustomScreenImplementation.java