Kanzi  3.9.4
Java API
NodeMetadata Interface Reference

Metadata definitions for Node. More...

Inheritance diagram for NodeMetadata:
[legend]

Classes

class  NodeComponentMessageArguments
 Metadata definitions for NodeComponentMessageArguments. More...
 
class  NodeComponentSourceMessageArguments
 Metadata definitions for NodeComponentSourceMessageArguments. More...
 

Public Attributes

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 Node.

Member Data Documentation

◆ ActualDepthProperty

DynamicPropertyType<Float> ActualDepthProperty
Initial value:
=
new DynamicPropertyType<>("Node.ActualDepth", Float.class)

The calculated size of the node in depth direction when used in a layout.

◆ ActualHeightProperty

DynamicPropertyType<Float> ActualHeightProperty
Initial value:
=
new DynamicPropertyType<>("Node.ActualHeight", Float.class)

The calculated height of the node when used in a layout.

◆ ActualWidthProperty

DynamicPropertyType<Float> ActualWidthProperty
Initial value:
=
new DynamicPropertyType<>("Node.ActualWidth", Float.class)

The calculated width of the node when used in a layout.

◆ ClipChildrenProperty

DynamicPropertyType<Boolean> ClipChildrenProperty
Initial value:
=
new DynamicPropertyType<>("Node.ClipChildren", Boolean.class)

Sets whether to clip the child nodes of thos node.

Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.

◆ ContentStretchProperty

DynamicPropertyType<Integer> ContentStretchProperty
Initial value:
=
new DynamicPropertyType<>("Node.ContentStretch", Integer.class)

Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).

◆ CreatedFromKZBProperty

DynamicPropertyType<Boolean> CreatedFromKZBProperty
Initial value:
=
new DynamicPropertyType<>("CreatedFromKZB", Boolean.class)

Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.

◆ DepthAlignmentProperty

DynamicPropertyType<Integer> DepthAlignmentProperty
Initial value:
=
new DynamicPropertyType<>("Node.DepthAlignment", Integer.class)

The alignment in depth direction the node should use when it resides under a layout.

◆ DepthMarginProperty

DynamicPropertyType<Vector2> DepthMarginProperty
Initial value:
=
new DynamicPropertyType<>("Node.DepthMargin", Vector2.class)

Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.

To set the Depth Margin property fields in a binding use:

  • Vector_X to access the Back property field
  • Vector_Y to access the Front property field

◆ DepthProperty

DynamicPropertyType<Float> DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)

The size of the node in depth direction when used in a layout.

Overrides the default bounds of the item.

◆ EffectivelyEnabledProperty

DynamicPropertyType<Boolean> EffectivelyEnabledProperty
Initial value:
=
new DynamicPropertyType<>("Node.EffectivelyEnabled", Boolean.class)

Indicates whether this node and its ancestor nodes are enabled.

Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled:

  • When that node is focused, it receives keyboard input until the focus moves to another node.
  • When that node is not focused, it is not part of the focus chain and does not receive keyboard input.

◆ EnabledProperty

DynamicPropertyType<Boolean> EnabledProperty
Initial value:
=
new DynamicPropertyType<>("Node.Enabled", Boolean.class)

Whether this node is enabled.

When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.

◆ FocusableProperty

DynamicPropertyType<Boolean> FocusableProperty
Initial value:
=
new DynamicPropertyType<>("Node.Focusable", Boolean.class)

Indicates whether the node can receive focus.

◆ FocusedProperty

DynamicPropertyType<Boolean> FocusedProperty
Initial value:
=
new DynamicPropertyType<>("Node.Focused", Boolean.class)

Indicates whether the node has keyboard focus.

◆ FocusStateProperty

DynamicPropertyType<Integer> FocusStateProperty
Initial value:
=
new DynamicPropertyType<>("Node.FocusState", Integer.class)

Reports the focus state of a node:

  • No focus (0) indicates that the node is not focused. For a focus scope node indicates that none of the nodes in the scope have focus.
  • Logical focus (1) indicates that the node is the logical focus node of an overlay-type focus scope. For a focus scope node indicates that one of the nodes in that scope is the logical focus node.
  • Keyboard focus (2) indicates that the node is the keyboard focus node of the application and receives keyboard input. For a focus scope node indicates that one of the nodes in that scope is the keyboard focus node.

Use this property in state managers and bindings to implement focus states in the UI nodes.

To observe whether a node is the keyboard focus node, you can use the boolean Focus > Focused property.

◆ FontFamilyProperty

DynamicPropertyType<Resource> FontFamilyProperty
Initial value:
=
new DynamicPropertyType<>("Node.FontFamily", Resource.class)

The font family used to render the text.

◆ HeightProperty

DynamicPropertyType<Float> HeightProperty
Initial value:
=
new DynamicPropertyType<>("Node.Height", Float.class)

The height of the node when used in a layout.

Overrides the default bounds of the item.

◆ HitTestableContainerProperty

DynamicPropertyType<Boolean> HitTestableContainerProperty
Initial value:
=
new DynamicPropertyType<>("Node.HitTestableContainer", Boolean.class)

When enabled, Kanzi uses the layout bounds as geometry for hit testing.

◆ HitTestableProperty

DynamicPropertyType<Boolean> HitTestableProperty
Initial value:
=
new DynamicPropertyType<>("Node.HitTestable", Boolean.class)

When enabled, users can pick the node from the default Camera node of the active Scene node.

For example, you must enable hit testing for Button nodes to work.

◆ HorizontalAlignmentProperty

DynamicPropertyType<Integer> HorizontalAlignmentProperty
Initial value:
=
new DynamicPropertyType<>("Node.HorizontalAlignment", Integer.class)

The alignment in horizontal direction the node should use when it resides under a layout.

◆ HorizontalMarginProperty

DynamicPropertyType<Vector2> HorizontalMarginProperty
Initial value:
=
new DynamicPropertyType<>("Node.HorizontalMargin", Vector2.class)

Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.

To set the Horizontal Margin property fields in a binding use:

  • Vector_X to access the Left property field
  • Vector_Y to access the Right property field

◆ HoverProperty

DynamicPropertyType<Boolean> HoverProperty
Initial value:
=
new DynamicPropertyType<>("Node.Hover", Boolean.class)

Indicates whether a node is the foremost hit testable node under the cursor.

◆ LocaleProperty

DynamicPropertyType<String> LocaleProperty
Initial value:
=
new DynamicPropertyType<>("Node.Locale", String.class)

The locale of the node.

◆ OpacityProperty

DynamicPropertyType<Float> OpacityProperty
Initial value:
=
new DynamicPropertyType<>("Node.Opacity", Float.class)

Opacity of the node.

◆ Projection2DTo3DScaleProperty

DynamicPropertyType<Float> Projection2DTo3DScaleProperty
Initial value:
=
new DynamicPropertyType<>("Node.Projection2DTo3DScale", Float.class)

Sets the scale factor to project pixels to 3D size.

When scale is 1, then the size of one pixel is one 3D space unit.

◆ StateManagerProperty

DynamicPropertyType<Resource> StateManagerProperty
Initial value:
=
new DynamicPropertyType<>("Node.StateManager", Resource.class)

Sets the State Manager to the node.

◆ StyleProperty

DynamicPropertyType<Resource> StyleProperty
Initial value:
=
new DynamicPropertyType<>("Node.Style", Resource.class)

Sets a style to the node.

◆ VerticalAlignmentProperty

DynamicPropertyType<Integer> VerticalAlignmentProperty
Initial value:
=
new DynamicPropertyType<>("Node.VerticalAlignment", Integer.class)

The alignment in vertical direction the node should use when it resides under a layout.

◆ VerticalMarginProperty

DynamicPropertyType<Vector2> VerticalMarginProperty
Initial value:
=
new DynamicPropertyType<>("Node.VerticalMargin", Vector2.class)

Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.

To set the Vertical Margin property fields in a binding use:

  • Vector_X to access the Bottom property field
  • Vector_Y to access the Top property field

◆ VisibleAmountInParentProperty

DynamicPropertyType<Float> VisibleAmountInParentProperty
Initial value:
=
new DynamicPropertyType<>("Node.VisibleAmountInParent", Float.class)

Sets the amount the node is inside its parent.

Use the value of this property in shaders to implement fades. Calculated by the parent node.

◆ VisibleProperty

DynamicPropertyType<Boolean> VisibleProperty
Initial value:
=
new DynamicPropertyType<>("Node.Visible", Boolean.class)

When disabled, Kanzi does not render the node.

◆ WidthProperty

DynamicPropertyType<Float> WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)

The width of the node when used in a layout.

Overrides the default bounds of the item.