Kanzi  3.9.2
Java API
PageMetadata Interface Reference

Metadata definitions for Page. More...

Inheritance diagram for PageMetadata:
[legend]

Classes

interface  ActivatedMessageArguments
 Metadata definitions for ActivatedMessageArguments. More...
 
interface  DeactivatedMessageArguments
 Metadata definitions for DeactivatedMessageArguments. More...
 
interface  NavigateMessageArguments
 Metadata definitions for NavigateMessageArguments. More...
 
interface  NavigateNextMessageArguments
 Metadata definitions for NavigateNextMessageArguments. More...
 
interface  NavigateParentMessageArguments
 Metadata definitions for NavigateParentMessageArguments. More...
 
interface  NavigatePreviousMessageArguments
 Metadata definitions for NavigatePreviousMessageArguments. More...
 
interface  NavigationActivatedMessageArguments
 Metadata definitions for NavigationActivatedMessageArguments. More...
 
interface  NavigationDeactivatedMessageArguments
 Metadata definitions for NavigationDeactivatedMessageArguments. More...
 
interface  NavigationFinishedMessageArguments
 Metadata definitions for NavigationFinishedMessageArguments. More...
 
interface  NavigationStartedMessageArguments
 Metadata definitions for NavigationStartedMessageArguments. More...
 
interface  RegisterToNavigationdMessageArguments
 Metadata definitions for RegisterToNavigationdMessageArguments. More...
 
interface  ScrollPageDownMessageArguments
 Metadata definitions for ScrollPageDownMessageArguments. More...
 
interface  ScrollPageUpMessageArguments
 Metadata definitions for ScrollPageUpMessageArguments. More...
 
interface  UnregisterFromNavigationMessageArguments
 Metadata definitions for UnregisterFromNavigationMessageArguments. More...
 

Public Attributes

AbstractMessageType ActivatedMessage = new AbstractMessageType("Message.Page.Activated")
 Page has been activated.
 
DynamicPropertyType< Boolean > AutoActivateProperty
 Always activate this Page node when its parent is active. More...
 
AbstractMessageType DeactivatedMessage = new AbstractMessageType("Message.Page.Deactivated")
 Page has been deactivated.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Page")
 Metaclass for Page.
 
AbstractMessageType NavigateMessage = new AbstractMessageType("Message.Page.Navigate")
 Navigates to the specified page, sets it as active.
 
AbstractMessageType NavigateParentMessage
 Navigates to the parent page. More...
 
AbstractMessageType NavigationActivatedMessage
 Page was activated by the navigation process. More...
 
AbstractMessageType NavigationDeactivatedMessage
 Page was deactivated by the navigation process. More...
 
AbstractMessageType RegisterToNavigationMessage
 Register Page in to navigation system. More...
 
DynamicPropertyType< Float > RotationOffsetProperty
 The angle in degrees by which to rotate a Page node. More...
 
DynamicPropertyType< Vector2ScaleOffsetProperty
 The factor by which to scale a Page node. More...
 
DynamicPropertyType< Vector2SlideOffsetProperty
 The offset to slide a Page node in horizontal or vertical direction: [-1, 1] to move the Page node horizontally [-1, 1] to move the Page node vertically. More...
 
DynamicPropertyType< Boolean > StateProperty
 The state of this Page node: false (inactive and invisible) or true (active and visible) (read-only). More...
 
DynamicPropertyType< Float > TransitionPhaseProperty
 The phase of the transition. More...
 
AbstractMessageType UnregisterFromNavigationMessage
 Unregister page from navigation system. More...
 

Detailed Description

Metadata definitions for Page.

Member Data Documentation

◆ AutoActivateProperty

DynamicPropertyType<Boolean> AutoActivateProperty
Initial value:
=
new DynamicPropertyType<>("Page.AutoActivate", Boolean.class)

Always activate this Page node when its parent is active.

◆ NavigateParentMessage

AbstractMessageType NavigateParentMessage
Initial value:
=
new AbstractMessageType("Message.Page.NavigateParent")

Navigates to the parent page.

◆ NavigationActivatedMessage

AbstractMessageType NavigationActivatedMessage
Initial value:
=
new AbstractMessageType("Message.Page.NavigationActivated")

Page was activated by the navigation process.

◆ NavigationDeactivatedMessage

AbstractMessageType NavigationDeactivatedMessage
Initial value:
=
new AbstractMessageType("Message.Page.NavigationDeactivated")

Page was deactivated by the navigation process.

◆ RegisterToNavigationMessage

AbstractMessageType RegisterToNavigationMessage
Initial value:
=
new AbstractMessageType("Message.Page.RegisterToNavigation")

Register Page in to navigation system.

◆ RotationOffsetProperty

DynamicPropertyType<Float> RotationOffsetProperty
Initial value:
=
new DynamicPropertyType<>("Page.RotationOffset", Float.class)

The angle in degrees by which to rotate a Page node.

◆ ScaleOffsetProperty

DynamicPropertyType<Vector2> ScaleOffsetProperty
Initial value:
=
new DynamicPropertyType<>("Page.ScaleOffset", Vector2.class)

The factor by which to scale a Page node.

◆ SlideOffsetProperty

DynamicPropertyType<Vector2> SlideOffsetProperty
Initial value:
=
new DynamicPropertyType<>("Page.SlideOffset", Vector2.class)

The offset to slide a Page node in horizontal or vertical direction: [-1, 1] to move the Page node horizontally [-1, 1] to move the Page node vertically.

◆ StateProperty

DynamicPropertyType<Boolean> StateProperty
Initial value:
=
new DynamicPropertyType<>("Page.State", Boolean.class)

The state of this Page node: false (inactive and invisible) or true (active and visible) (read-only).

◆ TransitionPhaseProperty

DynamicPropertyType<Float> TransitionPhaseProperty
Initial value:
=
new DynamicPropertyType<>("Page.TransitionPhase", Float.class)

The phase of the transition.

For example, use for pixel-based effects.

◆ UnregisterFromNavigationMessage

AbstractMessageType UnregisterFromNavigationMessage
Initial value:
=
new AbstractMessageType("Message.Page.UnregisterFromNavigation")

Unregister page from navigation system.