Class display

display
Defined in: display.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	display() Abstracts the system's means of displaying rendered data.

Field Summary
Field Attributes	Field Name and Description
	height Height of the display
	onClose Function called when a close event for the display is detected.
	onResize Function called when a resize event is detected for the display.
	width Width of the display
	x The X position of the display
	y The Y position of the display

Method Summary
Method Attributes	Method Name and Description
	fullscreen(fs) Set the display into a fullscreen context.
	hasInputFocus() Returns whether the display has user input focus.
	hide(hide) Attempts to hide the display.
	isCapable(capability) Returns whether or not the display is able to perform the requested capability.
	lockClientResize(lock) Attempts to prevent resizing on the user's side.
	lockPosition(lock) Attempts to prevent moving on the user's side.
	resize(width, height) Resizes the display.
	setName(name) Sets the name of the display.
	setPosition(x, y) Sets the position of the display.
	setViewPolicy(viewPolicy) Controls how the Renderer's information is displayed.

Class Detail

display()

Abstracts the system's means of displaying rendered data. Instantiates with sandboxe.display.create()

An interface for displaying rendered data

Field Detail

height

Height of the display

onClose

Function called when a close event for the display is detected.

onResize

Function called when a resize event is detected for the display. The function is called after the event is applied.

width

Width of the display

The X position of the display

The Y position of the display

Method Detail

fullscreen(fs)

Set the display into a fullscreen context. If fullscreen is not supported, no action is taken.

Parameters:
{Boolean} fs: Whether to enable or disable fullscreen

{Boolean} hasInputFocus()

Returns whether the display has user input focus. On display implementations where this doesnt apply, i.e. where there is only one logical display available,, this will always return true.

Returns:: {Boolean} Returns whether the display has input focus

hide(hide)

Attempts to hide the display. If hiding is not supported, no action is taken.

Parameters:
{Boolean} hide: Whether to hide the display

isCapable(capability)

Returns whether or not the display is able to perform the requested capability.

Parameters:
{Number} capability: The viewing policy. See sandboxe.display.capability.

lockClientResize(lock)

Attempts to prevent resizing on the user's side. For example, in a desktop environment, this would disable the feature of resizing the window.

Parameters:
{Boolean} lock: Whether to lock client resize.

lockPosition(lock)

Attempts to prevent moving on the user's side.

Parameters:
{Boolean} lock: Whether to lock client display position.

resize(width, height)

Resizes the display. If the display does not support resizing, no action is taken.

Parameters:
{Number} width: The new width
{Number} height: The new height

setName(name)

Sets the name of the display. On some systems, this can, for example, set the title bar of the application to the specified name.

Parameters:
{String} name: The new name.

setPosition(x, y)

Sets the position of the display. Usually, this is relative to whatever environment the display exists in. For example, in a desktop environment, this could be an offset from the DE's origin. If the display does not support moving, no action is taken.

Parameters:
{Number} x: The new x position of the display
{Number} y: The new y position of the display

setViewPolicy(viewPolicy)

Controls how the Renderer's information is displayed. The default policy is "MatchSize" See ViewPolicy for more information.

Parameters:
{Number} viewPolicy: The viewing policy. See sandboxe.display.viewPolicy.

Classes

Class display