Package tripleplay.ui

Class Background.Instance

java.lang.Object

tripleplay.ui.Background.Instance

All Implemented Interfaces:

AutoCloseable, react.Closeable

Enclosing class:

Background

public abstract class Background.Instance
extends Object
implements react.Closeable

An instantiation of a particular background template. Backgrounds are configured as a style property; elements instantiate them at specific dimensions when they are actually used.

Nested Class Summary

Nested classes/interfaces inherited from interface react.Closeable

react.Closeable.Set, react.Closeable.Util

Field Summary

Fields

Modifier and Type	Field	Description
final pythagoras.f.IDimension	size	The size at which this instance was prepared.

Method Summary

Modifier and Type	Method	Description
abstract void	addTo(GroupLayer parent, float x, float y, float depthAdjust)	Adds this background's layers to the specified group at the specified x/y offset.
Background	owner()	Returns the background that created this instance.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface react.Closeable

close

Field Details

size

public final pythagoras.f.IDimension size

The size at which this instance was prepared.

Method Details

owner

public Background owner()

Returns the background that created this instance.

addTo

public abstract void addTo(GroupLayer parent,
 float x,
 float y,
 float depthAdjust)

Adds this background's layers to the specified group at the specified x/y offset.

Parameters:

depthAdjust - an adjustment to the standard depth at which backgrounds are added. This adjustment is added to the standard background depth (-10). This allows one to control the rendering order of multiple backgrounds on a single widget.