All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 1.3.1
Show newest version






HSceneManager














org.ocap.ui
Class HSceneManager

java.lang.Object
  extended by org.ocap.ui.HSceneManager

public abstract class HSceneManager
extends java.lang.Object

This class represents a manager that lets an application register a handler to requested HScene changes within a logical HScreen composited with all HScenes. In addition, HScene z-ordering can be queried using this manager.


Constructor Summary
protected HSceneManager()
          Protected default constructor.
 
Method Summary
 int getAppHSceneLocation()
          Gets the current HScene z-order location for a specific HScene.
static OcapAppAttributes[] getHSceneOrder()
          Gets the current HScene z-ordering.
static HSceneManager getInstance()
          Gets the singleton instance of the HScene manager.
 void setHSceneChangeRequestHandler(HSceneChangeRequestHandler handler)
          Lets an application add itself as the HScene change request handler.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HSceneManager

protected HSceneManager()
Protected default constructor.

Method Detail

getInstance

public static HSceneManager getInstance()
Gets the singleton instance of the HScene manager. The singleton MAY be implemented using application or implementation scope.

Returns:
The HScene manager.

setHSceneChangeRequestHandler

public void setHSceneChangeRequestHandler(HSceneChangeRequestHandler handler)
Lets an application add itself as the HScene change request handler. If a handler is already registered when this method is called, it is replaced with the parameter handler.

Parameters:
handler - HSceneChangeRequestHandler for requests to HScene z-ordering changes. If this parameter is null the current handler is removed.
Throws:
java.lang.SecurityException - if the caller does not have MonitorAppPermission("handler.resource").

getHSceneOrder

public static OcapAppAttributes[] getHSceneOrder()
Gets the current HScene z-ordering. The array of attributes returned is ordered increasing in z-order where the first entry (0) corresponds to an HScene on top and the last entry is on bottom.

Returns:
Array of application attributes corresponding to HScene instances in z-order.
Throws:
java.lang.SecurityException - if the caller does not have MonitorAppPermission("handler.resource").

getAppHSceneLocation

public int getAppHSceneLocation()
Gets the current HScene z-order location for a specific HScene. Applications can call this to determine where their HScene is located.

Returns:
HScene z-order location for the calling application. The value is ordered increasing in z-order where 0 is on top and all other values are in increasing order below the top. A value of -1 indicates the HScene has not been ordered.






© 2015 - 2025 Weber Informatics LLC | Privacy Policy