com.jogamp.newt
Class Display

java.lang.Object
  extended by com.jogamp.newt.Display

public abstract class Display
extends Object


Field Summary
static boolean DEBUG
           
 
Constructor Summary
Display()
           
 
Method Summary
abstract  int addReference()
          The 1st call will initiate native creation, since we follow the lazy creation pattern.
abstract  void createNative()
          Manual trigger the native creation, if it is not done yet.
This is useful to be able to request the AbstractGraphicsDevice, via getGraphicsDevice().
Otherwise the abstract device won't be available before the dependent components (Screen and Window) are realized.
abstract  void destroy()
          Manually trigger the destruction, incl.
abstract  void dispatchMessages()
           
static void dumpDisplayList(String prefix)
           
 boolean equals(Object obj)
          return true if obj is of type Display and both FQN getFQName() equals
static int getActiveDisplayNumber()
           
static Collection<Display> getAllDisplays()
          Returns the global display collection
abstract  EDTUtil getEDTUtil()
           
static Display getFirstDisplayOf(String type, String name, int fromIndex, boolean shared)
           
abstract  String getFQName()
           
abstract  AbstractGraphicsDevice getGraphicsDevice()
          Return the AbstractGraphicsDevice used for depending resources lifecycle, i.e.
abstract  long getHandle()
          Return the handle of the AbstractGraphicsDevice as returned by getGraphicsDevice().
abstract  int getId()
           
static Display getLastDisplayOf(String type, String name, int fromIndex, boolean shared)
           
abstract  String getName()
           
abstract  int getReferenceCount()
           
static String getThreadName()
           
abstract  String getType()
           
abstract  int hashCode()
          return precomputed hashCode from FQN getFQName()
static int hashCodeNullSafe(Object o)
           
abstract  boolean isEDTRunning()
           
abstract  boolean isExclusive()
          Return true if this instance is exclusive, i.e.
abstract  boolean isNativeValid()
           
abstract  int removeReference()
          The last call may destroy this instance, if #getDestroyWhenUnused() returns true.
abstract  EDTUtil setEDTUtil(EDTUtil newEDTUtil)
          Sets a new EDTUtil and returns the previous one.
static String toHexString(int hex)
           
static String toHexString(long hex)
           
abstract  boolean validateEDT()
          Validate EDT running state.
Stop the running EDT in case this display is destroyed already.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEBUG

public static final boolean DEBUG
Constructor Detail

Display

public Display()
Method Detail

hashCode

public abstract int hashCode()
return precomputed hashCode from FQN getFQName()

Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
return true if obj is of type Display and both FQN getFQName() equals

Overrides:
equals in class Object

createNative

public abstract void createNative()
                           throws NativeWindowException
Manual trigger the native creation, if it is not done yet.
This is useful to be able to request the AbstractGraphicsDevice, via getGraphicsDevice().
Otherwise the abstract device won't be available before the dependent components (Screen and Window) are realized.

This method is usually invoke by addReference()

Throws:
NativeWindowException - if the native creation failed.

destroy

public abstract void destroy()
Manually trigger the destruction, incl. native destruction.

This method is usually invoke by removeReference()


validateEDT

public abstract boolean validateEDT()
Validate EDT running state.
Stop the running EDT in case this display is destroyed already.

Returns:
true if EDT has been stopped (destroyed but running), otherwise false.

isNativeValid

public abstract boolean isNativeValid()
Returns:
true if the native display handle is valid and ready to operate, otherwise false.
See Also:
destroy()

getReferenceCount

public abstract int getReferenceCount()
Returns:
number of references

addReference

public abstract int addReference()
                          throws NativeWindowException
The 1st call will initiate native creation, since we follow the lazy creation pattern.

Returns:
number of references post operation
Throws:
NativeWindowException - if the native creation failed.
See Also:
removeReference()

removeReference

public abstract int removeReference()
The last call may destroy this instance, if #getDestroyWhenUnused() returns true.

Returns:
number of references post operation
See Also:
addReference(), #getDestroyWhenUnused(), #setDestroyWhenUnused(boolean)

getGraphicsDevice

public abstract AbstractGraphicsDevice getGraphicsDevice()
Return the AbstractGraphicsDevice used for depending resources lifecycle, i.e. Screen and Window, as well as the event dispatching (EDT).


getHandle

public abstract long getHandle()
Return the handle of the AbstractGraphicsDevice as returned by getGraphicsDevice().


getFQName

public abstract String getFQName()
Returns:
The fully qualified Display name, which is a key of getType() + getName() + getId().

getId

public abstract int getId()
Returns:
this display internal serial id

getName

public abstract String getName()
Returns:
This display connection name as defined at creation time. The display connection name is a technical platform specific detail, see AbstractGraphicsDevice.getConnection().
See Also:
AbstractGraphicsDevice.getConnection()

getType

public abstract String getType()
Returns:
the native display type, ie NativeWindowFactory.getNativeWindowType(boolean)

isExclusive

public abstract boolean isExclusive()
Return true if this instance is exclusive, i.e. will not be shared.


setEDTUtil

public abstract EDTUtil setEDTUtil(EDTUtil newEDTUtil)
Sets a new EDTUtil and returns the previous one.

If newEDTUtil is null, the device's default EDTUtil is created and used.

If a previous one exists and it differs from the new one, it's being stopped, wait-until-idle and reset to allow a restart at a later time.

If newEDTUtil is not null and equals the previous one, no change is being made.

Note that newEDTUtil will be started by this method, if it is not running yet.


getEDTUtil

public abstract EDTUtil getEDTUtil()

isEDTRunning

public abstract boolean isEDTRunning()

dispatchMessages

public abstract void dispatchMessages()

dumpDisplayList

public static void dumpDisplayList(String prefix)

getFirstDisplayOf

public static Display getFirstDisplayOf(String type,
                                        String name,
                                        int fromIndex,
                                        boolean shared)
Parameters:
type -
name -
fromIndex - start index, then increasing until found or end of list
Returns:

getLastDisplayOf

public static Display getLastDisplayOf(String type,
                                       String name,
                                       int fromIndex,
                                       boolean shared)
Parameters:
type -
name -
fromIndex - start index, then decreasing until found or end of list. -1 is interpreted as size - 1.
Returns:

getAllDisplays

public static Collection<Display> getAllDisplays()
Returns the global display collection


getActiveDisplayNumber

public static int getActiveDisplayNumber()

getThreadName

public static String getThreadName()

toHexString

public static String toHexString(int hex)

toHexString

public static String toHexString(long hex)

hashCodeNullSafe

public static int hashCodeNullSafe(Object o)


Copyright 2010 JogAmp Community.