KanziView Interface Reference

Common interface for Kanzi view types. More...

Inheritance diagram for KanziView:

Public Member Functions
void	addListener (KanziViewListener listener)
	Adds state change listener for this view. More...
KanziViewAdapter	getAdapter ()
	Gets the adapter of this view. More...
Domain	getDomain ()
	Gets the Domain associated with this view. More...
String	getName ()
	Gets the name of the view and underlying native view node. More...
Node2D	getRoot ()
	Returns the root node of this view. More...
KanziRuntime	getRuntime ()
	Gets the KanziRuntime associated with this view. More...
void	handleOrientationChange (int orientation)
	Applies device orientation changes to the contents of this view. More...
void	handleVisibilityChange (boolean isVisible)
	Handles visibility change events. More...
void	removeListener (KanziViewListener listener)
	Removes state change listener from this view. More...
void	setClearColor (ColorRGBA color)
	Configures the color used to clear the surface of the view before rendering its contents. More...
void	setKzbPathList (String[] kzbPaths)
	Configures the list of kzb files that are loaded when the view is attached. More...
void	setName (String name)
	Sets the name for the view and underlying native view node. More...
void	setRoot (Node2D node)
	Sets the root node of this view, used to manually set content to the view. More...
void	setStartupPrefabUrl (String url)
	Configures the startup prefab that is automatically loaded during initialization. More...

Detailed Description

Common interface for Kanzi view types.

Member Function Documentation

addListener()

void addListener

(

KanziViewListener

listener

)

Adds state change listener for this view.

Parameters

listener

Listener to be called when events occur.

Implemented in KanziTextureView, and KanziSurfaceView.

getAdapter()

KanziViewAdapter getAdapter

(

)

Gets the adapter of this view.

Returns

Kanzi view adapter of this view.

Implemented in KanziTextureView, and KanziSurfaceView.

getDomain()

Domain getDomain

(

)

Gets the Domain associated with this view.

Returns

Domain associated with this view.

Implemented in KanziTextureView, and KanziSurfaceView.

getName()

String getName

(

)

Gets the name of the view and underlying native view node.

Returns

Name of the view.

Implemented in KanziTextureView, and KanziSurfaceView.

getRoot()

Node2D getRoot

(

)

Returns the root node of this view.

Returns

Root node of this view.

Implemented in KanziTextureView, and KanziSurfaceView.

getRuntime()

KanziRuntime getRuntime

(

)

Gets the KanziRuntime associated with this view.

Returns

KanziRuntime associated with this view.

Implemented in KanziTextureView, and KanziSurfaceView.

handleOrientationChange()

void handleOrientationChange

(

int

orientation

)

Applies device orientation changes to the contents of this view.

Parameters

orientation

The orientation qualifier from onOrientationChanged().

Implemented in KanziTextureView, and KanziSurfaceView.

handleVisibilityChange()

void handleVisibilityChange

(

boolean

isVisible

)

Handles visibility change events.

Forwards the visibility to the underlying native view node.

Parameters

isVisible

When the view is visible, set to True.

Implemented in KanziTextureView, and KanziSurfaceView.

removeListener()

void removeListener

(

KanziViewListener

listener

)

Removes state change listener from this view.

Parameters

listener

Listener to remove.

Implemented in KanziTextureView, and KanziSurfaceView.

setClearColor()

void setClearColor

(

ColorRGBA

color

)

Configures the color used to clear the surface of the view before rendering its contents.

Default value: Opaque black i.e. (0, 0, 0, 255).

Parameters

color

Color used to clear the surface of the view. Use null to skip clearing.

Implemented in KanziTextureView, and KanziSurfaceView.

setKzbPathList()

void setKzbPathList

(

String []

kzbPaths

)

Configures the list of kzb files that are loaded when the view is attached.

Parameters

kzbPaths

Array of kzb paths to load.

Implemented in KanziTextureView, and KanziSurfaceView.

setName()

void setName

(

String

name

)

Sets the name for the view and underlying native view node.

Parameters

name	New name for the view.

Implemented in KanziTextureView, and KanziSurfaceView.

setRoot()

void setRoot

(

Node2D

node

)

Sets the root node of this view, used to manually set content to the view.

Parameters

node	Node to be displayed in this view.

Implemented in KanziTextureView, and KanziSurfaceView.

setStartupPrefabUrl()

void setStartupPrefabUrl

(

String

url

)

Configures the startup prefab that is automatically loaded during initialization.

Parameters

url	Url of the prefab template to load.

Implemented in KanziTextureView, and KanziSurfaceView.