Kanzi  3.9.6
Java API
Button2DMetadata Interface Reference

Metadata definitions for Button2D. More...

Inheritance diagram for Button2DMetadata:
[legend]

Public Attributes

AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Button2D")
 Metaclass for Button2D.
 
- 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 this 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 the key 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, the node can be hit tested. 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...
 
- Public Attributes inherited from ButtonConceptMetadata
DynamicPropertyType< Float > AutoClickIntervalProperty
 Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message. More...
 
DynamicMessageType< ButtonConceptMetadata.CanceledMessageArguments > CancelMessage
 Occurs when a user lifts their finger outside of a Button that they previously pressed. More...
 
DynamicMessageType< ButtonConceptMetadata.ClickedMessageArguments > ClickMessage
 Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires. More...
 
DynamicMessageType< ButtonConceptMetadata.PressedMessageArguments > DownMessage
 Occurs when the user presses down the Button. More...
 
DynamicMessageType< ButtonConceptMetadata.PointerEnteredMessageArguments > EnterMessage
 Button: Enter trigger is set off: More...
 
DynamicPropertyType< Integer > IndexInGroupProperty
 Sets the index of the Button in the Toggle Button Group to which that Button is registered. More...
 
DynamicPropertyType< Boolean > IsPressedProperty
 Indicates whether the button is pressed and in the down state. More...
 
DynamicMessageType< ButtonConceptMetadata.PointerLeftMessageArguments > LeaveMessage
 Button: Leave trigger is set off: More...
 
DynamicPropertyType< Float > LongPressIntervalProperty
 Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture. More...
 
DynamicMessageType< ButtonConceptMetadata.LongPressMessageArguments > LongPressMessage
 Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ButtonConcept")
 Metaclass for ButtonConcept.
 
DynamicPropertyType< Boolean > PressOnHoverProperty
 Whether holding a finger on the device screen and moving it over the button transitions the button to the down state. More...
 
DynamicMessageType< ButtonConceptMetadata.ToggledOffMessageArguments > ToggledOffMessage
 Occurs when the Button is toggled off. More...
 
DynamicMessageType< ButtonConceptMetadata.ToggledOnMessageArguments > ToggledOnMessage
 Occurs when the Button is toggled on. More...
 
DynamicPropertyType< Integer > ToggleStateCountProperty
 Sets the number of toggle states of the Button. More...
 
DynamicMessageType< ButtonConceptMetadata.ToggleStateChangedMessageArguments > ToggleStateMessage
 Occurs when the toggle state of the Button changes. More...
 
DynamicPropertyType< Integer > ToggleStateProperty
 Sets the toggle state of the Button. More...
 
- Public Attributes inherited from ClickConceptMetadata
DynamicPropertyType< Boolean > DoubleClickEnabledProperty
 Whether to install a multi-click manipulator that generates double-click messages. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ClickConcept")
 Metaclass for ClickConcept.
 

Detailed Description

Metadata definitions for Button2D.