Kanzi  3.9.4
Java API
PageMetadata Interface Reference

Metadata definitions for Page. More...

Inheritance diagram for PageMetadata:
[legend]

Classes

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

Public Attributes

DynamicMessageType< PageMetadata.ActivatedMessageArguments > ActivatedMessage
 Page has been activated. More...
 
DynamicPropertyType< Boolean > AutoActivateProperty
 Always activate this Page node when its parent is active. More...
 
DynamicMessageType< PageMetadata.DeactivatedMessageArguments > DeactivatedMessage
 Page has been deactivated. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Page")
 Metaclass for Page.
 
DynamicMessageType< PageMetadata.NavigateMessageArguments > NavigateMessage
 Navigates to the specified page, sets it as active. More...
 
DynamicMessageType< PageMetadata.NavigateParentMessageArguments > NavigateParentMessage
 Navigates to the parent page. More...
 
DynamicMessageType< PageMetadata.NavigationActivatedMessageArguments > NavigationActivatedMessage
 Page was activated by the navigation process. More...
 
DynamicMessageType< PageMetadata.NavigationDeactivatedMessageArguments > NavigationDeactivatedMessage
 Page was deactivated by the navigation process. More...
 
DynamicMessageType< PageMetadata.RegisterToNavigationdMessageArguments > 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...
 
DynamicMessageType< PageMetadata.UnregisterFromNavigationMessageArguments > UnregisterFromNavigationMessage
 Unregister page from navigation system. More...
 
- Public Attributes inherited from Node2DMetadata
DynamicPropertyType< Float > AspectRatioProperty
 Determines the proportion of width and height. More...
 
DynamicPropertyType< ResourceBackgroundBrushProperty
 The background brush to paint the background of 2D nodes. More...
 
DynamicPropertyType< Boolean > CacheValidProperty
 Indicates whether the node is cached. More...
 
DynamicPropertyType< Integer > CachingModeProperty
 Sets the caching mode of this node: More...
 
DynamicPropertyType< ResourceCompositionBrushProperty
 The brush to use to compose 2D nodes to screen. More...
 
DynamicPropertyType< Boolean > DisableRenderTargetClearProperty
 Do not clear render target buffers before rendering into it even if necessary. More...
 
DynamicPropertyType< ResourceEffectPrefabProperty
 The 2D Effect to use for this node. More...
 
DynamicPropertyType< ResourceEffectProperty
 Reports the runtime effect instance that this node uses. More...
 
DynamicPropertyType< Boolean > ForceCompositionProperty
 Force rendering to composing target even if not otherwise necessary. More...
 
DynamicPropertyType< ResourceForegroundBrushProperty
 The foreground brush to paint the foreground of 2D nodes. More...
 
DynamicPropertyType< Integer > ForegroundHintProperty
 Give a hint of the type of the foreground of 2D nodes: More...
 
DynamicPropertyType< SRTValue2DLayoutTransformationProperty
 The 2D transformation to be applied before layouting. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node2D")
 Metaclass for Node2D.
 
DynamicPropertyType< Boolean > OffscreenRenderingProperty
 When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen. More...
 
DynamicPropertyType< Float > PerspectiveTransformationFovProperty
 The 3D transformation field of view (degrees) to be applied after layouting. More...
 
DynamicPropertyType< Integer > PerspectiveTransformationModeProperty
 Defines the mode of operation for the coordinate system and field of view. More...
 
DynamicPropertyType< Vector3PerspectiveTransformationOriginProperty
 The 3D transformation origin to be used for perspective transformation on this or child nodes. More...
 
DynamicPropertyType< Vector3PerspectiveTransformationPivotProperty
 The 3D pivot point in relative coordinates. More...
 
DynamicPropertyType< SRTValue3DPerspectiveTransformationProperty
 The 3D transformation to be applied after layouting. More...
 
DynamicPropertyType< Integer > PixelFormatProperty
 The pixel format of the node if rendering to a texture. More...
 
DynamicPropertyType< Boolean > RenderSelfProperty
 Whether the node renders itself. More...
 
DynamicPropertyType< Float > RenderTargetMinimumHeightProperty
 Sets the minimum height of implicitly generated render targets. More...
 
DynamicPropertyType< Float > RenderTargetMinimumWidthProperty
 Sets the minimum width of implicitly generated render targets. More...
 
DynamicPropertyType< ResourceRenderTargetProperty
 Forces the node to be rendered into a given render target texture. More...
 
DynamicPropertyType< Float > RenderTargetReallocationLimitProperty
 The change in size that triggers reallocation of a render target. More...
 
DynamicPropertyType< Vector2RenderTransformationOriginProperty
 Sets the render transform origin in relative coordinates. More...
 
DynamicPropertyType< SRTValue2DRenderTransformationProperty
 The 2D transformation to be applied after layouting. More...
 
DynamicPropertyType< Boolean > SnapToPixelProperty
 Snap the translation of the node and its size into pixel boundary. More...
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< Float > ActualDepthProperty
 The calculated size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Float > ActualHeightProperty
 The calculated height of the node when used in a layout. More...
 
DynamicPropertyType< Float > ActualWidthProperty
 The calculated width of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > ClipChildrenProperty
 Sets whether to clip the child nodes of thos node. More...
 
DynamicPropertyType< Integer > ContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). More...
 
DynamicPropertyType< Boolean > CreatedFromKZBProperty
 Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file. More...
 
DynamicPropertyType< Integer > DepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Boolean > EffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled. More...
 
DynamicPropertyType< Boolean > EnabledProperty
 Whether this node is enabled. More...
 
DynamicPropertyType< Boolean > FocusableProperty
 Indicates whether the node can receive focus. More...
 
DynamicPropertyType< Boolean > FocusedProperty
 Indicates whether the node has keyboard focus. More...
 
DynamicPropertyType< Integer > FocusStateProperty
 Reports the focus state of a node: More...
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text. More...
 
DynamicPropertyType< Float > HeightProperty
 The height of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > HitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing. More...
 
DynamicPropertyType< Boolean > HitTestableProperty
 When enabled, users can pick the node from the default Camera node of the active Scene node. More...
 
DynamicPropertyType< Integer > HorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Boolean > HoverProperty
 Indicates whether a node is the foremost hit testable node under the cursor. More...
 
DynamicPropertyType< String > LocaleProperty
 The locale of the node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node")
 Metaclass for Node.
 
DynamicPropertyType< String > NameProperty = new DynamicPropertyType<>("Node.Name", String.class)
 Node name.
 
DynamicPropertyType< Float > OpacityProperty
 Opacity of the node. More...
 
DynamicPropertyType< String > PathProperty = new DynamicPropertyType<>("Node.Path", String.class)
 Full path to the node.
 
DynamicPropertyType< Float > Projection2DTo3DScaleProperty
 Sets the scale factor to project pixels to 3D size. More...
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node. More...
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node. More...
 
DynamicPropertyType< Integer > VerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > VisibleAmountInParentProperty
 Sets the amount the node is inside its parent. More...
 
DynamicPropertyType< Boolean > VisibleProperty
 When disabled, Kanzi does not render the node. More...
 
DynamicPropertyType< Float > WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout. More...
 

Detailed Description

Metadata definitions for Page.

Member Data Documentation

◆ ActivatedMessage

DynamicMessageType<PageMetadata.ActivatedMessageArguments> ActivatedMessage
Initial value:
=
new DynamicMessageType<>(
"Message.Page.Activated", PageMetadata.ActivatedMessageArguments.class)

Page has been activated.

◆ AutoActivateProperty

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

Always activate this Page node when its parent is active.

◆ DeactivatedMessage

DynamicMessageType<PageMetadata.DeactivatedMessageArguments> DeactivatedMessage
Initial value:
=
new DynamicMessageType<>(
"Message.Page.Deactivated", PageMetadata.DeactivatedMessageArguments.class)

Page has been deactivated.

◆ NavigateMessage

DynamicMessageType<PageMetadata.NavigateMessageArguments> NavigateMessage
Initial value:
=
new DynamicMessageType<>(
"Message.Page.Navigate", PageMetadata.NavigateMessageArguments.class)

Navigates to the specified page, sets it as active.

◆ NavigateParentMessage

DynamicMessageType<PageMetadata.NavigateParentMessageArguments> NavigateParentMessage
Initial value:
=
new DynamicMessageType<>(
"Message.Page.NavigateParent", PageMetadata.NavigateParentMessageArguments.class)

Navigates to the parent page.

◆ NavigationActivatedMessage

DynamicMessageType<PageMetadata.NavigationActivatedMessageArguments> NavigationActivatedMessage
Initial value:
= new DynamicMessageType<>("Message.Page.NavigationActivated",
PageMetadata.NavigationActivatedMessageArguments.class)

Page was activated by the navigation process.

◆ NavigationDeactivatedMessage

DynamicMessageType<PageMetadata.NavigationDeactivatedMessageArguments> NavigationDeactivatedMessage
Initial value:
=
new DynamicMessageType<>("Message.Page.NavigationDeactivated",
PageMetadata.NavigationDeactivatedMessageArguments.class)

Page was deactivated by the navigation process.

◆ RegisterToNavigationMessage

DynamicMessageType<PageMetadata.RegisterToNavigationdMessageArguments> RegisterToNavigationMessage
Initial value:
= new DynamicMessageType<>("Message.Page.RegisterToNavigation",
PageMetadata.RegisterToNavigationdMessageArguments.class)

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

DynamicMessageType<PageMetadata.UnregisterFromNavigationMessageArguments> UnregisterFromNavigationMessage
Initial value:
=
new DynamicMessageType<>("Message.Page.UnregisterFromNavigation",
PageMetadata.UnregisterFromNavigationMessageArguments.class)

Unregister page from navigation system.