com.jogamp.newt
Class Screen

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

public abstract class Screen
extends Object


Field Summary
static boolean DEBUG
           
static int SCREEN_MODE_CHANGE_TIMEOUT
          A 10s timeout for screen mode change.
 
Constructor Summary
Screen()
           
 
Method Summary
abstract  int addReference()
          See Display.addReference()
abstract  void addScreenModeListener(ScreenModeListener sml)
           
abstract  void createNative()
          Manual trigger the native creation, if it is not done yet..
This is useful to be able to request the AbstractGraphicsScreen, via getGraphicsScreen().
Otherwise the abstract device won't be available before the dependent component (Window) is realized.
abstract  void destroy()
          Manually trigger the destruction, incl.
 boolean equals(Object obj)
          return true if obj is of type Display and both FQN getFQName() equals
static int getActiveScreenNumber()
           
static Collection<Screen> getAllScreens()
          Returns the global display collection
abstract  ScreenMode getCurrentScreenMode()
          Return the current ScreenMode.
abstract  Display getDisplay()
           
static Screen getFirstScreenOf(Display display, int idx, int fromIndex)
           
abstract  String getFQName()
           
abstract  AbstractGraphicsScreen getGraphicsScreen()
           
abstract  int getHeight()
           
abstract  int getIndex()
           
static Screen getLastScreenOf(Display display, int idx, int fromIndex)
           
abstract  ScreenMode getOriginalScreenMode()
          Return the original ScreenMode, as used at NEWT initialization.
abstract  int getReferenceCount()
           
abstract  List<ScreenMode> getScreenModes()
          Return a list of available ScreenModes.
abstract  int getWidth()
           
abstract  int hashCode()
          return precomputed hashCode from FQN getFQName()
abstract  boolean isNativeValid()
           
abstract  int removeReference()
          See Display.removeReference()
abstract  void removeScreenModeListener(ScreenModeListener sml)
           
abstract  boolean setCurrentScreenMode(ScreenMode screenMode)
          Set the current ScreenMode.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCREEN_MODE_CHANGE_TIMEOUT

public static final int SCREEN_MODE_CHANGE_TIMEOUT
A 10s timeout for screen mode change. It is observed, that some platforms need a notable amount of time for this task, especially in case of rotation change.

See Also:
Constant Field Values

DEBUG

public static final boolean DEBUG
Constructor Detail

Screen

public Screen()
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 AbstractGraphicsScreen, via getGraphicsScreen().
Otherwise the abstract device won't be available before the dependent component (Window) is realized.

This method is usually invoke by addReference()

This method invokes Display.addReference() after creating the native peer,
which will issue Display.createNative() if the reference count was 0.

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()

This method invokes Display.removeReference() after it's own destruction,
which will issue Display.destroy() if the reference count becomes 0.


isNativeValid

public abstract boolean isNativeValid()

getReferenceCount

public abstract int getReferenceCount()
Returns:
number of references by Window

addReference

public abstract int addReference()
                          throws NativeWindowException
See Display.addReference()

Throws:
NativeWindowException - if the native creation failed.
See Also:
removeReference(), #setDestroyWhenUnused(boolean), #getDestroyWhenUnused()

removeReference

public abstract int removeReference()
See Display.removeReference()

See Also:
addReference(), #setDestroyWhenUnused(boolean), #getDestroyWhenUnused()

getGraphicsScreen

public abstract AbstractGraphicsScreen getGraphicsScreen()

getIndex

public abstract int getIndex()
Returns:
this Screen index of all Screens of getDisplay().

getWidth

public abstract int getWidth()
Returns:
the current screen width

getHeight

public abstract int getHeight()
Returns:
the current screen height

getDisplay

public abstract Display getDisplay()
Returns:
the associated Display

getFQName

public abstract String getFQName()
Returns:
the screen fully qualified Screen name, which is a key of Display.getFQName() + getIndex().

addScreenModeListener

public abstract void addScreenModeListener(ScreenModeListener sml)
Parameters:
sml - ScreenModeListener to be added for ScreenMode change events

removeScreenModeListener

public abstract void removeScreenModeListener(ScreenModeListener sml)
Parameters:
sml - ScreenModeListener to be removed from ScreenMode change events

getScreenModes

public abstract List<ScreenMode> getScreenModes()
Return a list of available ScreenModes.

Returns:
a shallow copy of the internal immutable ScreenModes, or null if not implemented for this native type Display.getType().

getOriginalScreenMode

public abstract ScreenMode getOriginalScreenMode()
Return the original ScreenMode, as used at NEWT initialization.

Returns:
null if functionality not implemented, otherwise the original ScreenMode which is element of the list getScreenModes().

getCurrentScreenMode

public abstract ScreenMode getCurrentScreenMode()
Return the current ScreenMode.

Returns:
null if functionality not implemented, otherwise the current ScreenMode which is element of the list getScreenModes().

setCurrentScreenMode

public abstract boolean setCurrentScreenMode(ScreenMode screenMode)
Set the current ScreenMode.

Parameters:
screenMode - to be made current, must be element of the list getScreenModes().
Returns:
true if successful, otherwise false

getFirstScreenOf

public static Screen getFirstScreenOf(Display display,
                                      int idx,
                                      int fromIndex)
Parameters:
type -
name -
fromIndex - start index, then increasing until found or end of list *
Returns:

getLastScreenOf

public static Screen getLastScreenOf(Display display,
                                     int idx,
                                     int fromIndex)
Parameters:
type -
name -
fromIndex - start index, then decreasing until found or end of list. -1 is interpreted as size - 1.
Returns:

getAllScreens

public static Collection<Screen> getAllScreens()
Returns the global display collection


getActiveScreenNumber

public static int getActiveScreenNumber()


Copyright 2010 JogAmp Community.