Page Class Reference
Use Page nodes to create the structure of an application user interface. More...
Inheritance diagram for Page:
Static Public Member Functions | |
| static< T extends KanziObject > ObjectRef< T > | create (Domain domain, String name) |
| Creates a Page node. | |
Static Public Attributes | |
| static final Metaclass | metaclass = com.rightware.kanzi.metadata.PageMetadata.metaclass |
| The Metaclass for the class. | |
 Static Public Attributes inherited from Node2D | |
| static final Metaclass | metaclass = com.rightware.kanzi.metadata.Node2DMetadata.metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from Node | |
| static final Metaclass | metaclass = com.rightware.kanzi.metadata.NodeMetadata.metaclass |
| The Metaclass for the class. | |
| Static Public Attributes inherited from KanziObject | |
| static final Metaclass | metaclass = new AbstractMetaclass("Kanzi.Object") |
| The Metaclass for the class. | |
Additional Inherited Members | |
| Public Member Functions inherited from Node2D | |
| void | addChild (Node2D node) |
| Adds a child node. | |
| void | arrange () |
| Arranges this node. | |
| void | close () |
| Close the object, and release native resources. | |
| Vector2 | getActualSize () |
| Gets actual size. | |
| Vector2 | getAllocatedSize () |
| Gets allocated size. | |
| Matrix3x3 | getArrangeTransform () |
| Get arrange transform. | |
| float | getAspectRatio () |
| Gets the value of #AspectRatioProperty. | |
| Resource | getBackgroundBrush () |
| Gets value of #BackgroundBrushProperty. | |
| CachingMode | getCachingMode () |
| Gets the value of #CachingModeProperty. | |
| Node2D | getChild (int index) |
| Returns a child from given index from node. | |
| int | getChildCount () |
| Gets the number of children of the node. | |
| int | getChildIndex (Node child) |
| Returns the index of a child in a node. | |
| Resource | getCompositionBrush () |
| Gets value of #CompositionBrushProperty. | |
| Vector2 | getDesiredSize () |
| Gets desired size. | |
| Resource | getForegroundBrush () |
| Gets value of #ForegroundBrushProperty. | |
| SRTValue2D | getLayoutTransformation () |
| Gets the value of #LayoutTransformationProperty. | |
| SRTValue3D | getPerspectiveTransformation () |
| Gets the value of #PerspectiveTransformationProperty. | |
| float | getPerspectiveTransformationFov () |
| Gets the value of #PerspectiveTransformationFovProperty. | |
| Vector3 | getPerspectiveTransformationOrigin () |
| Gets the value of #PerspectiveTransformationOriginProperty. | |
| Vector3 | getPerspectiveTransformationPivot () |
| Gets the value of #PerspectiveTransformationPivotProperty. | |
| Resource | getRenderTarget () |
| Gets value of #RenderTargetProperty. | |
| float | getRenderTargetMinimumHeight () |
| Gets the value of #RenderTargetMinimumHeightProperty. | |
| float | getRenderTargetMinimumWidth () |
| Gets the value of #RenderTargetMinimumWidthProperty. | |
| float | getRenderTargetReallocationLimit () |
| Gets the value of #RenderTargetReallocationLimitProperty. | |
| SRTValue2D | getRenderTransformation () |
| Gets the value of #RenderTransformationProperty. | |
| Vector2 | getRenderTransformationOrigin () |
| Gets the value of #RenderTransformationOriginProperty. | |
| Matrix3x3 | getWorldTransform () |
| Gets the world transformation matrix. | |
| boolean | hasChild (Node child) |
| Returns whether or not the child exists. | |
| void | insertChild (int index, Node2D child) |
| Adds a child node for object node to given index. | |
| boolean | isDisableRenderTargetClear () |
| Gets the value of #DisableRenderTargetClearProperty. | |
| boolean | isOffscreenRendering () |
| Gets the value of #OffscreenRenderingProperty. | |
| boolean | isRenderSelf () |
| Gets the value of #RenderSelfProperty. | |
| boolean | isSnapToPixel () |
| Gets the value of #SnapToPixelProperty. | |
| Iterable< Node2D > | iterateChildren () |
| Gets an Iterable object used to iterate the Node2D children. | |
| Iterable< Node2D > | iterateChildrenReverse () |
| Gets an Reverse Iterable object used to iterate the Node2D children. | |
| void | layout () |
| Does layout pass starting from this node and iterating recursively all of its children. | |
| boolean | measure (Vector2 availableSize, boolean handleStretch) |
| Measures this node. | |
| void | moveToBack () |
| Repositions the node to the beginning of its parent's children, so that it is drawn first. | |
| void | moveToFront () |
| Repositions the node to the end of its parent's children, so that it is drawn last. | |
| void | removeAllChildren () |
| Removes all child nodes. | |
| void | removeChild (int index) |
| Removes child node at specified index. | |
| void | removeChild (Node2D node) |
| Removes child node. | |
| void | setActualSize (Vector2 actualSize) |
| Sets actual size. | |
| void | setAllocatedSize (Vector2 allocatedSize) |
| Sets allocated size. | |
| void | setArrangeTransform (Matrix3x3 transform) |
| Set arrange transform. | |
| void | setAspectRatio (float value) |
| Sets the value of #AspectRatioProperty. | |
| void | setAutoSize () |
| Sets node to automatically determine width, height and depth. | |
| void | setBackgroundBrush (Resource value) |
| Sets value of #BackgroundBrushProperty. | |
| void | setCachingMode (CachingMode value) |
| Sets the value of #CachingModeProperty. | |
| void | setCompositionBrush (Resource value) |
| Sets value of #CompositionBrushProperty. | |
| void | setDesiredSize (Vector2 size) |
| Sets desired size. | |
| void | setDisableRenderTargetClear (boolean value) |
| Sets the value of #DisableRenderTargetClearProperty. | |
| void | setForegroundBrush (Resource value) |
| Sets value of #ForegroundBrushProperty. | |
| void | setLayoutTransformation (SRTValue2D value) |
| Sets the value of #LayoutTransformationProperty. | |
| void | setOffscreenRendering (boolean value) |
| Sets the value of #OffscreenRenderingProperty. | |
| void | setPerspectiveTransformation (SRTValue3D value) |
| Sets the value of #PerspectiveTransformationProperty. | |
| void | setPerspectiveTransformationFov (float value) |
| Sets the value of #PerspectiveTransformationProperty. | |
| void | setPerspectiveTransformationOrigin (Vector3 value) |
| Sets the value of #PerspectiveTransformationOriginProperty. | |
| void | setPerspectiveTransformationPivot (Vector3 value) |
| Sets the value of #PerspectiveTransformationPivotProperty. | |
| void | setRenderSelf (boolean value) |
| Sets the value of #RenderSelfProperty. | |
| void | setRenderTarget (Resource texture) |
| Sets value of #RenderTargetProperty. | |
| void | setRenderTargetMinimumHeight (float value) |
| Sets the value of #RenderTargetMinimumHeightProperty. | |
| void | setRenderTargetMinimumWidth (float value) |
| Sets the value of #RenderTargetMinimumWidthProperty. | |
| void | setRenderTargetReallocationLimit (float value) |
| Sets the value of #RenderTargetReallocationLimitProperty. | |
| void | setRenderTransformation (SRTValue2D value) |
| Sets the value of #RenderTransformationProperty. | |
| void | setRenderTransformationOrigin (Vector2 value) |
| Sets the value of #RenderTransformationOriginProperty. | |
| void | setSize (float width, float height) |
| Sets size properties of the node. | |
| void | setSnapToPixel (boolean value) |
| Sets the value of #SnapToPixelProperty. | |
| void | transform () |
| Transforms a single Node2D. | |
| Public Member Functions inherited from Node | |
| ObjectRef< TResourceType > | acquireResource (ResourceID resourceId) throws ObjectNotFoundException |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| ResourceDictionary | acquireResourceDictionary () |
| Gets a resource dictionary of a node. | |
| ResourceManager.AcquireTask | acquireResourcesAsync (ResourceID resourceId, ResourceManager.AcquireTask.Callback callback) |
| Posts an asynchronous task to acquire a resource. | |
| boolean | addAbstractChild (Node child) |
| Adds a node as child of this node. | |
| void | addAnonymousResource (Resource resource) |
| Adds anonymous resource (such as style) for object node resources. | |
| void | addInputManipulator (InputManipulator inputManipulator) |
| Attaches an input manipulator to the node. | |
| MessageSubscriptionToken | addMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction) |
| Adds a message filter where the filter is a function. | |
| MessageSubscriptionToken | addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction) |
| Adds a message handler where the handler is a function. | |
| MessageSubscriptionToken | addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction, Node messageSourceFilter) |
| Adds a message handler where the handler is a function. | |
| void | addNodeComponent (NodeComponent component) |
| Transfers the ownership of a node component to an object node. | |
| void | addNodeComponentWithOwner (NodeComponent component, KanziObject owner) |
| Transfers the ownership of a node component to an object node and sets the owner of the node component. | |
| void | addResource (ResourceID resourceId, String resourceUrl) |
| Adds a resource manager resource to an object node. | |
| void | addResourceDictionary (ResourceDictionary resourceDictionary) |
| Adds a nested resource dictionary to the resource dictionary of a node. | |
| MessageSubscriptionToken | addTunnelingMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction) |
| Adds a message filter where the filter is a function. | |
| MessageSubscriptionToken | addTunnelingMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction, Node messageSourceFilter) |
| Adds a message handler where the handler is a function and you explicitly define the accepted source. | |
| void | attachRecursive () |
| Attaches a node and its children recursively. | |
| void | clearChangeFlag (PropertyTypeChangeFlag flag) |
| Clears a change flag. | |
| boolean | containsResource (ResourceID resourceId) |
| Returns if object node resource dictionary contains the resource with given ID. | |
| void | detachRecursive () |
| Detaches a node and its children recursively. | |
| void | dispatchMessage (MessageType< MessageArgumentsType > messageType, MessageArgumentsType arguments) |
| Dispatches a message from this node with specified arguments. | |
| String | findResourceUrl (ResourceID resourceId) |
| Tries to find Resource URL for Resource ID from this node. | |
| Node | getAbstractChild (int index) |
| Returns node at given child index. | |
| int | getAbstractChildCount () |
| Returns number of child nodes. | |
| int | getAbstractChildIndex (Node node) |
| Returns index of given node in list of child nodes. | |
| float | getActualDepth () |
| Gets the value of #ActualDepthProperty. | |
| float | getActualHeight () |
| Gets the value of #ActualHeightProperty. | |
| float | getActualWidth () |
| Gets the value of #ActualWidthProperty. | |
| float | getDepth () |
| Gets the value of #DepthProperty. | |
| Vector2 | getDepthMargin () |
| Gets the value of #DepthMarginProperty. | |
| float | getHeight () |
| Gets the value of #HeightProperty. | |
| Vector2 | getHorizontalMargin () |
| Gets the value of #HorizontalMarginProperty. | |
| String | getLocale () |
| Gets the value of #LocaleProperty. | |
| String | getName () |
| Gets the value of #NameProperty. | |
| float | getOpacity () |
| Gets the value of #OpacityProperty. | |
| Node | getParent () |
| Gets parent of this node. | |
| String | getPath () |
| Gets the value of #PathProperty. | |
| ResourceDictionary | getResourceDictionary () |
| If a node has a resource dictionary, returns the resource dictionary of that node. | |
| Resource | getStateManager () |
| Gets the value of #StateManagerProperty. | |
| Resource | getStyle () |
| Gets the value of #StyleProperty. | |
| Vector2 | getVerticalMargin () |
| Gets the value of #VerticalMarginProperty. | |
| float | getWidth () |
| Gets the value of #WidthProperty. | |
| void | invalidateArrange () |
| Invalidates arrange for the node. | |
| void | invalidateDraw () |
| Invalidates draw flag for the node. | |
| void | invalidateFinalTransform () |
| Invalidates final transform for node. | |
| void | invalidateMeasure () |
| Invalidates measure for the node. | |
| void | invalidateRender () |
| Invalidates render for the node. | |
| boolean | isAnyChangeFlagSet (EnumSet< PropertyTypeChangeFlag > flags) |
| Checks if any of a set of change flags is set. | |
| boolean | isAnyChildChangeFlagSet (EnumSet< PropertyTypeChangeFlag > flags) |
| Checks if any of a set of change flags is set on a child. | |
| boolean | isAttached () |
| Checks if node is attached to ui tree. | |
| boolean | isAttaching () |
| Checks if node is in the process of attaching to ui tree. | |
| boolean | isChangeFlagSet (PropertyTypeChangeFlag flag) |
| Checks if a change flag is set. | |
| boolean | isChildChangeFlagSet (PropertyTypeChangeFlag flag) |
| Checks if a change flag is set on a child. | |
| boolean | isClipChildren () |
| Gets the value of #ClipChildrenProperty. | |
| boolean | isDetaching () |
| Checks if node is in the process of getting detached from ui tree. | |
| boolean | isEffectivelyEnabled () |
| Returns whether a node and its ancestor nodes are enabled. | |
| boolean | isEffectivelyFocusable () |
| Returns whether a node and its ancestor focus scope nodes are focusable. | |
| boolean | isEffectivelyVisible () |
| Returns whether a node and its ancestor nodes are visible. | |
| boolean | isEnabled () |
| Gets the value of #EnabledProperty. | |
| boolean | isFocusable () |
| Gets the value of the #FocusableProperty. | |
| boolean | isFocused () |
| Sets whether a node is an active focus node and can receive keyboard messages. | |
| boolean | isHitTestable () |
| Gets the value of #HitTestableProperty. | |
| boolean | isHitTestableContainer () |
| Gets the value of #HitTestableContainerProperty. | |
| boolean | isHover () |
| Gets the value of #HoverProperty. | |
| boolean | isInitialized () |
| Checks if initialize() has been called. | |
| boolean | isInvalidArrange () |
| Check if the node needs arrange. | |
| boolean | isInvalidDraw () |
| Tells if node draw flag is invalid. | |
| boolean | isInvalidFinalTransform () |
| Tells if final transform flag is invalid for node. | |
| boolean | isInvalidMeasure () |
| Check if the node needs measure. | |
| boolean | isInvalidRender () |
| Returns if node render flag is invalid. | |
| boolean | isNamed (String name) |
| Checks if node has a given name. | |
| boolean | isVisible () |
| Gets the value of #VisibleProperty. | |
| Iterable< NodeComponent > | iterateNodeComponents () |
| Gets an Iterable object used to iterate the Node Components. | |
| T | lookupNode (String path) |
| Returns a node of specified type by looking it up with specified path or alias. | |
| NodeComponent | lookupNodeComponentByName (String name) |
| Look up a Node Component by Name. | |
| KanziObject | lookupObject (String path) |
| Returns a KanziObject by looking it up with specified path or alias. | |
| void | notifyResourceDictionaryModified () |
| Forces the re-evaluation of resource IDs in a node tree. | |
| boolean | removeAbstractChild (Node child) |
| Removes child node from this node. | |
| void | removeAnonymousResource (Resource resource) |
| Removes anonymous resource from object node resources. | |
| void | removeBinding (AbstractBindingRuntime bindingRuntime) |
| Removes a binding runtime added earlier. | |
| void | removeBindingsWithOwner (KanziObject owner) |
| Removes binding runtimes owned by a KanziObject. | |
| void | removeInputManipulator (InputManipulator inputManipulator) |
| Detaches an input manipulator from the node. | |
| void | removeMessageHandler (MessageSubscriptionToken token) |
| Removes a message subscription. | |
| void | removeNodeComponent (NodeComponent component) |
| Removes the ownership of a node component from an object node. | |
| void | removeNodeComponentWithOwner (KanziObject owner) |
| Removes all node component bindings with the specified owner. | |
| void | removeResource (ResourceID resourceId) |
| Removes a resource with given ID from object node resource dictionary. | |
| void | setActualDepth (float value) |
| Sets the value of #ActualDepthProperty. | |
| void | setActualHeight (float value) |
| Sets the value of #ActualHeightProperty. | |
| void | setActualWidth (float value) |
| Sets the value of #ActualWidthProperty. | |
| void | setAutoHeight () |
| Sets node to automatically determine height. | |
| void | setAutoWidth () |
| Sets node to automatically determine width. | |
| AbstractBindingRuntime | setBinding (AbstractBinding binding) |
| Sets a binding. | |
| AbstractBindingRuntime | setBinding (AbstractBinding binding, PropertyType<?> propertyType) |
| Sets a binding. | |
| AbstractBindingRuntime | setBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField) |
| Sets a binding. | |
| AbstractBindingRuntime | setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType) |
| Sets a binding with owner. | |
| AbstractBindingRuntime | setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField) |
| Sets a binding with owner. | |
| void | setChangeFlag (PropertyTypeChangeFlag flag) |
| Sets a change flag. | |
| void | setClipChildren (boolean value) |
| Sets the value of #ClipChildrenProperty. | |
| void | setDepth (float value) |
| Sets the value of #DepthProperty. | |
| void | setDepthMargin (Vector2 value) |
| Sets the value of #DepthMarginProperty. | |
| void | setEnabled (boolean value) |
| Sets the value of the #EnabledProperty. | |
| void | setFocusable (boolean value) |
| Sets the value of the #FocusableProperty. | |
| void | setFocused (boolean value) |
| Sets the value of the #FocusedProperty. | |
| void | setHeight (float value) |
| Sets the value of #HeightProperty. | |
| void | setHitTestable (boolean value) |
| Sets the value of #HitTestableProperty. | |
| void | setHitTestableContainer (boolean value) |
| Sets the value of #HitTestableContainerProperty. | |
| void | setHorizontalMargin (Vector2 value) |
| Sets the value of #HorizontalMarginProperty. | |
| void | setHover (boolean value) |
| Sets the value of #HoverProperty. | |
| void | setLocale (String value) |
| Sets the value of #LocaleProperty. | |
| AbstractBindingRuntime | setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType) |
| Sets a modifier binding. | |
| AbstractBindingRuntime | setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField) |
| Sets a modifier binding. | |
| AbstractBindingRuntime | setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType) |
| Sets a modifier binding with owner. | |
| AbstractBindingRuntime | setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField) |
| Sets a modifier binding with owner. | |
| void | setName (String name) |
| Sets the value of #NameProperty. | |
| void | setOpacity (float value) |
| Sets the value of #OpacityProperty. | |
| void | setResourceDictionary (ResourceDictionary resourceDictionary) |
| Replaces the resource dictionary of a node. | |
| void | setStateManager (Resource value) |
| Sets the value of #StateManagerProperty. | |
| void | setStyle (Resource value) |
| Sets the value of #StyleProperty. | |
| void | setVerticalMargin (Vector2 value) |
| Sets the value of #VerticalMarginProperty. | |
| void | setVisible (boolean value) |
| Sets the value of #VisibleProperty. | |
| void | setWidth (float value) |
| Sets the value of #WidthProperty. | |
| ObjectRef< TResourceType > | tryAcquireResource (ResourceID resourceId) |
| Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. | |
| Node | trySetFocus () |
| Tries to move the focus on this node. | |
| void | validateArrange () |
| Validates arrange for the node. | |
| void | validateDraw () |
| Validates draw flags for the node. | |
| void | validateMeasure () |
| Validates measure for the node. | |
| void | validateRender () |
| Validates render for the node. | |
| Public Member Functions inherited from KanziObject | |
| boolean | equals (Object object) |
| Domain | getDomain () |
| Returns the domain the object belongs to. | |
| Metaclass | getDynamicMetaclass () |
| Returns the metaclass of the dynamic type of the object. | |
| long | getNative () |
| Gets a pointer to the backing C++ instance. | |
| TDataType | getOptionalProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type, but does not use the default value if there are no inputs to the property value. | |
| TDataType | getProperty (PropertyType< TDataType > propertyType) |
| Returns the current value of a property type. | |
| int | hashCode () |
| boolean | hasValue (PropertyType< TDataType > propertyType) |
| Evaluates whether there are any inputs into the property value. | |
| boolean | isStale () |
| Test if the object is stale i.e. | |
| void | removeLocalValue (PropertyType< TDataType > propertyType) |
| Removes the local value associated with the property. | |
| void | setProperty (PropertyType< TDataType > propertyType, TDataType value) |
| Sets the local value of a property type. | |
| ObjectRef< TType > | tryCreateObjectRef (Class< TType > clazz) |
| Tries to create an owning ObjectRef instance to this KanziObject. | |
| Public Attributes inherited from NodeMetadata | |
| DynamicPropertyType< Float > | ActualDepthProperty |
| The calculated size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Float > | ActualHeightProperty |
| The calculated height of the node when used in a layout. | |
| DynamicPropertyType< Float > | ActualWidthProperty |
| The calculated width of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | ClipChildrenProperty |
| Sets whether to clip the child nodes of this node. | |
| DynamicPropertyType< NodeEnums.ContentStretch > | ContentStretchProperty |
| Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). | |
| 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. | |
| DynamicPropertyType< NodeEnums.DepthAlignment > | DepthAlignmentProperty |
| The alignment in depth direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | DepthMarginProperty |
| Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class) |
| The size of the node in depth direction when used in a layout. | |
| DynamicPropertyType< Boolean > | EffectivelyEnabledProperty |
| Indicates whether this node and its ancestor nodes are enabled. | |
| DynamicPropertyType< Boolean > | EnabledProperty |
| Whether this node is enabled. | |
| DynamicPropertyType< Boolean > | FocusableProperty |
| Indicates whether the node can receive focus. | |
| DynamicPropertyType< Boolean > | FocusedProperty |
| Indicates whether the node has the key focus. | |
| DynamicPropertyType< FocusState > | FocusStateProperty |
| Reports the focus state of a node: | |
| DynamicPropertyType< Resource > | FontFamilyProperty |
| The font family used to render the text. | |
| DynamicPropertyType< Float > | HeightProperty |
| The height of the node when used in a layout. | |
| DynamicPropertyType< Boolean > | HitTestableContainerProperty |
| When enabled, Kanzi uses the layout bounds as geometry for hit testing. | |
| DynamicPropertyType< Boolean > | HitTestableProperty |
| When enabled, the node can be hit tested. | |
| DynamicPropertyType< NodeEnums.HorizontalAlignment > | HorizontalAlignmentProperty |
| The alignment in horizontal direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | HorizontalMarginProperty |
| Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Boolean > | HoverProperty |
| Indicates whether a node is the foremost hit testable node under the cursor. | |
| DynamicPropertyType< String > | LocaleProperty |
| The locale of the node. | |
| 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. | |
| 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. | |
| DynamicPropertyType< Resource > | StateManagerProperty |
| Sets the State Manager to the node. | |
| DynamicPropertyType< Resource > | StyleProperty |
| Sets a style to the node. | |
| DynamicPropertyType< NodeEnums.VerticalAlignment > | VerticalAlignmentProperty |
| The alignment in vertical direction the node should use when it resides under a layout. | |
| DynamicPropertyType< Vector2 > | VerticalMarginProperty |
| Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. | |
| DynamicPropertyType< Float > | VisibleAmountInParentProperty |
| Sets the amount the node is inside its parent. | |
| DynamicPropertyType< Boolean > | VisibleProperty |
| When disabled, Kanzi does not render the node. | |
| DynamicPropertyType< Float > | WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class) |
| The width of the node when used in a layout. | |
| Public Attributes inherited from Node2DMetadata | |
| DynamicPropertyType< Float > | AspectRatioProperty |
| Determines the proportion of width and height. | |
| DynamicPropertyType< Resource > | BackgroundBrushProperty |
| The background brush to paint the background of 2D nodes. | |
| DynamicPropertyType< Boolean > | CacheValidProperty |
| Indicates whether the node is cached. | |
| DynamicPropertyType< CachingMode > | CachingModeProperty |
| Sets the caching mode of this node: | |
| DynamicPropertyType< Resource > | CompositionBrushProperty |
| The brush to use to compose 2D nodes to screen. | |
| DynamicPropertyType< Boolean > | DisableRenderTargetClearProperty |
| Do not clear render target buffers before rendering into it even if necessary. | |
| DynamicPropertyType< Resource > | EffectPrefabProperty |
| The 2D Effect to use for this node. | |
| DynamicPropertyType< Resource > | EffectProperty |
| Reports the runtime effect instance that this node uses. | |
| DynamicPropertyType< Boolean > | ForceCompositionProperty |
| Force rendering to composing target even if not otherwise necessary. | |
| DynamicPropertyType< Resource > | ForegroundBrushProperty |
| The foreground brush to paint the foreground of 2D nodes. | |
| DynamicPropertyType< Node2DEnums.ForegroundHint > | ForegroundHintProperty |
| Give a hint of the type of the foreground of 2D nodes: | |
| DynamicPropertyType< SRTValue2D > | LayoutTransformationProperty |
| The 2D transformation to be applied before layouting. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Node2D") |
| Metaclass for Node2D. | |
| DynamicPropertyType< MultisampleCount > | MultisampleLevelProperty |
| Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node. | |
| DynamicPropertyType< Boolean > | OffscreenRenderingProperty |
| When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen. | |
| DynamicPropertyType< Float > | PerspectiveTransformationFovProperty |
| The 3D transformation field of view (degrees) to be applied after layouting. | |
| DynamicPropertyType< Node2DEnums.PerspectiveTransformationMode > | PerspectiveTransformationModeProperty |
| Defines the mode of operation for the coordinate system and field of view. | |
| DynamicPropertyType< Vector3 > | PerspectiveTransformationOriginProperty |
| The 3D transformation origin to be used for perspective transformation on this or child nodes. | |
| DynamicPropertyType< Vector3 > | PerspectiveTransformationPivotProperty |
| The 3D pivot point in relative coordinates. | |
| DynamicPropertyType< SRTValue3D > | PerspectiveTransformationProperty |
| The 3D transformation to be applied after layouting. | |
| DynamicPropertyType< Node2DEnums.PixelFormat > | PixelFormatProperty |
| The pixel format of the node if rendering to a texture. | |
| DynamicPropertyType< Boolean > | RenderSelfProperty |
| Whether the node renders itself. | |
| DynamicPropertyType< Float > | RenderTargetMinimumHeightProperty |
| Sets the minimum height of implicitly generated render targets. | |
| DynamicPropertyType< Float > | RenderTargetMinimumWidthProperty |
| Sets the minimum width of implicitly generated render targets. | |
| DynamicPropertyType< Resource > | RenderTargetProperty |
| Forces the node to be rendered into a given render target texture. | |
| DynamicPropertyType< Float > | RenderTargetReallocationLimitProperty |
| The change in size that triggers reallocation of a render target. | |
| DynamicPropertyType< Vector2 > | RenderTransformationOriginProperty |
| Sets the render transform origin in relative coordinates. | |
| DynamicPropertyType< SRTValue2D > | RenderTransformationProperty |
| The 2D transformation to be applied after layouting. | |
| DynamicPropertyType< Boolean > | SnapToPixelProperty |
| Snap the translation of the node and its size into pixel boundary. | |
| Public Attributes inherited from PageMetadata | |
| DynamicMessageType< PageMetadata.ActivatedMessageArguments > | ActivatedMessage |
| Page has been activated. | |
| DynamicPropertyType< Boolean > | AutoActivateProperty |
| Always activate this Page node when its parent is active. | |
| DynamicMessageType< PageMetadata.DeactivatedMessageArguments > | DeactivatedMessage |
| Page has been deactivated. | |
| AbstractMetaclass | metaclass = new AbstractMetaclass("Kanzi.Page") |
| Metaclass for Page. | |
| DynamicMessageType< PageMetadata.NavigateMessageArguments > | NavigateMessage |
| Navigates to the specified page, sets it as active. | |
| DynamicMessageType< PageMetadata.NavigateParentMessageArguments > | NavigateParentMessage |
| Navigates to the parent page. | |
| DynamicMessageType< PageMetadata.NavigationActivatedMessageArguments > | NavigationActivatedMessage |
| Page was activated by the navigation process. | |
| DynamicMessageType< PageMetadata.NavigationDeactivatedMessageArguments > | NavigationDeactivatedMessage |
| Page was deactivated by the navigation process. | |
| DynamicMessageType< PageMetadata.RegisterToNavigationdMessageArguments > | RegisterToNavigationMessage |
| Register Page in to navigation system. | |
| DynamicPropertyType< Float > | RotationOffsetProperty |
| The angle in degrees by which to rotate a Page node. | |
| DynamicPropertyType< Vector2 > | ScaleOffsetProperty |
| The factor by which to scale a Page node. | |
| DynamicPropertyType< Vector2 > | SlideOffsetProperty |
| The offset to slide a Page node in horizontal or vertical direction:\nX [-1, 1] to move the Page node horizontally\nY [-1, 1] to move the Page node vertically. | |
| DynamicPropertyType< Boolean > | StateProperty |
| The state of this Page node: false (inactive and invisible) or true (active and visible) (read-only). | |
| DynamicPropertyType< Float > | TransitionPhaseProperty |
| The phase of the transition. | |
| DynamicMessageType< PageMetadata.UnregisterFromNavigationMessageArguments > | UnregisterFromNavigationMessage |
| Unregister page from navigation system. | |
| Protected Member Functions inherited from Node2D | |
| Node2D (Domain domain, long nativeNode, Metaclass metaclass) | |
| Wraps a given native node. | |
| void | arrangeOverride (Vector2 actualSize) |
| Performs setting of actual node size and transformation calculations. | |
| void | initialize () |
| Initializes the Node2D. | |
| Vector2 | measureOverride (Vector2 availableSize) |
| Performs node size calculation. | |
| void | onAttached () |
| Called when this node becomes attached. | |
| void | onDetached () |
| Called when this node becomes detached. | |
| void | onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
| Method executed on node property change. | |
| void | updateRenderOverride () |
| Performs node-specific updates before render. | |
| Static Protected Member Functions inherited from Node2D | |
| static< Derived extends Node2D > ObjectRef< Derived > | createDerived (Domain domain, String name, Metaclass metaclass) |
| Creates a derived class instance. | |
Detailed Description
Use Page nodes to create the structure of an application user interface.
For example, you can create different parts of the user interface, such as Home, Media Browser, Navigation, or Settings screens, each in their own hierarchy of Page nodes.