org.ocap.ui.HSceneChangeRequestHandler.html Maven / Gradle / Ivy

Interface to be implemented by a privileged application in order to handle requests to display an HScene not currently displayed, or change the positions of HScenes on the screen, or move an HScene in the 'z' order.

testShow

boolean testShow(HSceneBinding newScene,
                 HSceneBinding[] oldScenes)

Tests whether an HScene display request can be allowed or not. The implementation SHALL call this method whenever the HScene is to be displayed including when the HScene show or setvisible(true) methods are called.

Parameters:

newScene - the new HScene to be displayed

oldScenes - the existing displayed HScenes

Returns:

true if the new HScene is allowed to be displayed false if it is not allowed to be displayed

testMove

boolean testMove(HSceneBinding move,
                 HSceneBinding[] currentScenes)

Tests whether an HScene move request can be allowed or not. Called when an HScene is to be moved around the HScreen or resized.

Parameters:

move - the new location/size of the HScene.

currentScenes - the existing HScenes including the current location of the HScene to move.

Returns:

True if the move can be made, otherwise returns false.

testOrder

boolean testOrder(HSceneBinding[] currentScenes,
                  int currentOrder,
                  int newOrder)

Tests if an HScene z-order change request can be made or not. Called when an HScene is to be moved in z-order.

Parameters:

currentScenes - the existing displayed HScenes in z-order with entry 0 being the front.

currentOrder - the existing position in the currentScene array of the HScene to move.

newOrder - the new position that it is requested to move the HScene to.

Returns:

True if the move can be made, otherwise returns false.