Kanzi  3.9.5
Java API
Node Class Reference

Base class for Kanzi nodes. More...

Inheritance diagram for Node:
[legend]

Classes

enum  ContentStretch
 Content stretch option. More...
 
enum  DepthAlignment
 Depth alignment options. More...
 
enum  HorizontalAlignment
 Horizontal alignment options. More...
 
interface  MessageSubscriptionFunction
 Defines the message handler invoked when a node receives a message it listens to. More...
 
class  MessageSubscriptionToken
 Message subscription token that identifies a message subscription. More...
 
enum  VerticalAlignment
 Vertical alignment options. More...
 

Public Member Functions

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. More...
 
ResourceManager.AcquireTask acquireResourcesAsync (ResourceID resourceId, ResourceManager.AcquireTask.Callback callback)
 Posts an asynchronous task to acquire a resource. More...
 
boolean addAbstractChild (Node child)
 Adds a node as child of this node. More...
 
void addAnonymousResource (Resource resource)
 Adds anonymous resource (such as style) for object node resources. More...
 
void addInputManipulator (InputManipulator inputManipulator)
 Attaches an input manipulator to the node. More...
 
MessageSubscriptionToken addMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message filter where the filter is a function. More...
 
MessageSubscriptionToken addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message handler where the handler is a function. More...
 
MessageSubscriptionToken addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction, Node messageSourceFilter)
 Adds a message handler where the handler is a function. More...
 
void addNodeComponent (NodeComponent component)
 Transfers the ownership of a node component to an object node. More...
 
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. More...
 
void addResource (ResourceID resourceId, String resourceUrl)
 Adds a resource manager resource to an object node. More...
 
MessageSubscriptionToken addTunnelingMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message filter where the filter is a function. More...
 
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. More...
 
void attachRecursive ()
 Attaches a node and its children recursively.
 
void clearChangeFlag (PropertyTypeChangeFlag flag)
 Clears a change flag. More...
 
boolean containsResource (ResourceID resourceId)
 Returns if object node resource dictionary contains the resource with given ID. More...
 
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. More...
 
String findResourceUrl (ResourceID resourceId)
 Tries to find Resource URL for Resource ID from this node. More...
 
Node getAbstractChild (int index)
 Returns node at given child index. More...
 
int getAbstractChildCount ()
 Returns number of child nodes. More...
 
int getAbstractChildIndex (Node node)
 Returns index of given node in list of child nodes. More...
 
float getActualDepth ()
 Gets the value of ActualDepthProperty. More...
 
float getActualHeight ()
 Gets the value of ActualHeightProperty. More...
 
float getActualWidth ()
 Gets the value of ActualWidthProperty. More...
 
float getDepth ()
 Gets the value of DepthProperty. More...
 
Vector2 getDepthMargin ()
 Gets the value of DepthMarginProperty. More...
 
float getHeight ()
 Gets the value of HeightProperty. More...
 
Vector2 getHorizontalMargin ()
 Gets the value of HorizontalMarginProperty. More...
 
String getLocale ()
 Gets the value of LocaleProperty. More...
 
String getName ()
 Gets the value of NameProperty. More...
 
float getOpacity ()
 Gets the value of OpacityProperty. More...
 
Node getParent ()
 Gets parent of this node. More...
 
String getPath ()
 Gets the value of PathProperty. More...
 
Resource getStateManager ()
 Gets the value of StateManagerProperty. More...
 
Resource getStyle ()
 Gets the value of StyleProperty. More...
 
Vector2 getVerticalMargin ()
 Gets the value of VerticalMarginProperty. More...
 
float getWidth ()
 Gets the value of WidthProperty. More...
 
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. More...
 
boolean isAnyChildChangeFlagSet (EnumSet< PropertyTypeChangeFlag > flags)
 Checks if any of a set of change flags is set on a child. More...
 
boolean isAttached ()
 Checks if node is attached to ui tree. More...
 
boolean isAttaching ()
 Checks if node is in the process of attaching to ui tree. More...
 
boolean isChangeFlagSet (PropertyTypeChangeFlag flag)
 Checks if a change flag is set. More...
 
boolean isChildChangeFlagSet (PropertyTypeChangeFlag flag)
 Checks if a change flag is set on a child. More...
 
boolean isClipChildren ()
 Gets the value of ClipChildrenProperty. More...
 
boolean isDetaching ()
 Checks if node is in the process of getting detached from ui tree. More...
 
boolean isEffectivelyEnabled ()
 Returns whether a node and its ancestor nodes are enabled. More...
 
boolean isEffectivelyFocusable ()
 Returns whether a node and its ancestor focus scope nodes are focusable. More...
 
boolean isEffectivelyVisible ()
 Returns whether a node and its ancestor nodes are visible. More...
 
boolean isEnabled ()
 Gets the value of EnabledProperty. More...
 
boolean isFocusable ()
 Gets the value of the FocusableProperty. More...
 
boolean isFocused ()
 Sets whether a node is an active focus node and can receive keyboard messages. More...
 
boolean isHitTestable ()
 Gets the value of HitTestableProperty. More...
 
boolean isHitTestableContainer ()
 Gets the value of HitTestableContainerProperty. More...
 
boolean isHover ()
 Gets the value of HoverProperty. More...
 
boolean isInitialized ()
 Checks if initialize() has been called. More...
 
boolean isInvalidArrange ()
 Check if the node needs arrange. More...
 
boolean isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
boolean isInvalidFinalTransform ()
 Tells if final transform flag is invalid for node. More...
 
boolean isInvalidMeasure ()
 Check if the node needs measure. More...
 
boolean isInvalidRender ()
 Returns if node render flag is invalid. More...
 
boolean isNamed (String name)
 Checks if node has a given name. More...
 
boolean isVisible ()
 Gets the value of VisibleProperty. More...
 
Iterable< NodeComponentiterateNodeComponents ()
 Gets an Iterable object used to iterate the Node Components. More...
 
lookupNode (String path)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
NodeComponent lookupNodeComponentByName (String name)
 Look up a Node Component by Name. More...
 
KanziObject lookupObject (String path)
 Returns a KanziObject by looking it up with specified path or alias. More...
 
boolean removeAbstractChild (Node child)
 Removes child node from this node. More...
 
void removeAnonymousResource (Resource resource)
 Removes anonymous resource from object node resources. More...
 
void removeBinding (AbstractBindingRuntime bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (KanziObject owner)
 Removes binding runtimes owned by a KanziObject. More...
 
void removeInputManipulator (InputManipulator inputManipulator)
 Detaches an input manipulator from the node. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
void removeNodeComponent (NodeComponent component)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (KanziObject owner)
 Removes all node component bindings with the specified owner. More...
 
void removeResource (ResourceID resourceId)
 Removes a resource with given ID from object node resource dictionary. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
void setAutoHeight ()
 Sets node to automatically determine height.
 
void setAutoWidth ()
 Sets node to automatically determine width.
 
AbstractBindingRuntime setBinding (AbstractBinding binding)
 Sets a binding. More...
 
AbstractBindingRuntime setBinding (AbstractBinding binding, PropertyType<?> propertyType)
 Sets a binding. More...
 
AbstractBindingRuntime setBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a binding. More...
 
AbstractBindingRuntime setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType)
 Sets a binding with owner. More...
 
AbstractBindingRuntime setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a binding with owner. More...
 
void setChangeFlag (PropertyTypeChangeFlag flag)
 Sets a change flag. More...
 
void setClipChildren (boolean value)
 Sets the value of ClipChildrenProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
void setEnabled (boolean value)
 Sets the value of the EnabledProperty. More...
 
void setFocusable (boolean value)
 Sets the value of the FocusableProperty. More...
 
void setFocused (boolean value)
 Sets the value of the FocusedProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
void setHitTestable (boolean value)
 Sets the value of HitTestableProperty. More...
 
void setHitTestableContainer (boolean value)
 Sets the value of HitTestableContainerProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
void setHover (boolean value)
 Sets the value of HoverProperty. More...
 
void setLocale (String value)
 Sets the value of LocaleProperty. More...
 
AbstractBindingRuntime setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType)
 Sets a modifier binding. More...
 
AbstractBindingRuntime setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a modifier binding. More...
 
AbstractBindingRuntime setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType)
 Sets a modifier binding with owner. More...
 
AbstractBindingRuntime setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a modifier binding with owner. More...
 
void setName (String name)
 Sets the value of NameProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
void setStateManager (Resource value)
 Sets the value of StateManagerProperty. More...
 
void setStyle (Resource value)
 Sets the value of StyleProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
void setVisible (boolean value)
 Sets the value of VisibleProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
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. More...
 
Node trySetFocus ()
 Tries to move the focus on this node. More...
 
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. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
long getNative ()
 Gets a pointer to the backing C++ instance. More...
 
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. More...
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type. More...
 
EnumType getProperty (PropertyType< Integer > propertyType, Class< EnumType > enumClass)
 Returns the current value of an integer property type converted to a matching constant from specified enumeration. More...
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property. More...
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type. More...
 
void setProperty (PropertyType< Integer > propertyType, EnumType value)
 Sets the local value of an integer property type using a constant from an enumeration. More...
 

Static Public Attributes

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

Base class for Kanzi nodes.

Member Function Documentation

◆ acquireResource()

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.

If the resource id maps to a resource url, but the url doesn't map to any resource, throws an exception.

Parameters
resourceIdName of the resource.
Returns
The acquired resource
Exceptions
ObjectNotFoundExceptionThrows a ObjectNotFoundException when the resourceId is not found.

◆ acquireResourcesAsync()

ResourceManager.AcquireTask acquireResourcesAsync ( ResourceID  resourceId,
ResourceManager.AcquireTask.Callback  callback 
)

Posts an asynchronous task to acquire a resource.

Parameters
resourceIdName of the resource.
callbackCallback function that this function calls when resource loading is completed.
Returns
Handle to the async load task. You can pass the handle to ResourceManager#wait(ResourceManager.AcquireTask) to wait for the completion of the load.

◆ addAbstractChild()

boolean addAbstractChild ( Node  child)

Adds a node as child of this node.

Parameters
childNode to add as child.
Returns
True if operation was successful, otherwise false.

◆ addAnonymousResource()

void addAnonymousResource ( Resource  resource)

Adds anonymous resource (such as style) for object node resources.

Parameters
resourceThe resource to be added.

◆ addInputManipulator()

void addInputManipulator ( InputManipulator  inputManipulator)

Attaches an input manipulator to the node.

Parameters
inputManipulatorThe input manipulator to add.

◆ addMessageFilter()

MessageSubscriptionToken addMessageFilter ( MessageType< MessageArgumentsType >  messageType,
MessageSubscriptionFunction< MessageArgumentsType >  messageHandlerFunction 
)

Adds a message filter where the filter is a function.

The filter is invoked when a message of messageType bubbles through the node the filter is added to.

Parameters
messageTypeThe message type to listen to.
messageHandlerFunctionThe function invoked when the node that owns the filter receives a matching message.
<MessageArgumentsType>The message arguments class associated with the message type.
Returns
The MessageSubscriptionToken which identifies the added filter.

◆ addMessageHandler() [1/2]

MessageSubscriptionToken addMessageHandler ( MessageType< MessageArgumentsType >  messageType,
MessageSubscriptionFunction< MessageArgumentsType >  messageHandlerFunction 
)

Adds a message handler where the handler is a function.

The handler is invoked when a message of messageType is signaled in the node the handler is added to.

Parameters
messageTypeThe message type to listen to.
messageHandlerFunctionThe function invoked when the node that owns the handler receives a matching message. The source of the message has to be the node itself.
<MessageArgumentsType>The message arguments class associated with the message type.
Returns
The MessageSubscriptionToken which identifies the added handler.

◆ addMessageHandler() [2/2]

MessageSubscriptionToken addMessageHandler ( MessageType< MessageArgumentsType >  messageType,
MessageSubscriptionFunction< MessageArgumentsType >  messageHandlerFunction,
Node  messageSourceFilter 
)

Adds a message handler where the handler is a function.

The handler is invoked when a message of messageType from the source specified is signaled in the node the handler is added to.

Parameters
messageTypeThe message type to listen to.
messageHandlerFunctionThe function invoked when the node that owns the handler receives a matching message.
messageSourceFilterThe handler will only be called when the message is from this source.
<MessageArgumentsType>The message arguments class associated with the message type.
Returns
The MessageSubscriptionToken which identifies the added handler.

◆ addNodeComponent()

void addNodeComponent ( NodeComponent  component)

Transfers the ownership of a node component to an object node.

Parameters
componentThe component being added.

◆ addNodeComponentWithOwner()

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.

Parameters
componentThe component being added.
ownerThe Kanzi object that owns the lifetime of the component.

◆ addResource()

void addResource ( ResourceID  resourceId,
String  resourceUrl 
)

Adds a resource manager resource to an object node.

If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown.

Parameters
resourceIdResource id of the resource.
resourceUrlResource url of the resource.

◆ addTunnelingMessageFilter()

MessageSubscriptionToken addTunnelingMessageFilter ( MessageType< MessageArgumentsType >  messageType,
MessageSubscriptionFunction< MessageArgumentsType >  messageHandlerFunction 
)

Adds a message filter where the filter is a function.

The filter is invoked when a message of messageType tunnels through the node to which you add this filter.

Parameters
messageTypeThe message type to listen to.
messageHandlerFunctionThe function invoked when the node that owns the filter receives a matching message.
<MessageArgumentsType>The message arguments class associated with the message type.
Returns
The MessageSubscriptionToken which identifies the added filter.

◆ addTunnelingMessageHandler()

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.

The handler is invoked when a message of messageType tunnels through the node to which you add the handler, but only when you dispatch it from the given source node.

Parameters
messageTypeThe message type to listen to.
messageHandlerFunctionThe function invoked when the node that owns the handler receives a matching message. The source of the message has to be the node itself.
messageSourceFilterSource node of the messages.
<MessageArgumentsType>The message arguments class associated with the message type.
Returns
The MessageSubscriptionToken which identifies the added handler.

◆ clearChangeFlag()

void clearChangeFlag ( PropertyTypeChangeFlag  flag)

Clears a change flag.

Parameters
flagThe flag to clear

◆ containsResource()

boolean containsResource ( ResourceID  resourceId)

Returns if object node resource dictionary contains the resource with given ID.

Resource can be any type: style, alias or resource manager resource.

Parameters
resourceIdResource id of resource to check.
Returns
True if node contains this resource, otherwise false.

◆ dispatchMessage()

void dispatchMessage ( MessageType< MessageArgumentsType >  messageType,
MessageArgumentsType  arguments 
)

Dispatches a message from this node with specified arguments.

Parameters
messageTypeThe type of the dispatched message.
argumentsThe arguments of the dispatched message.
<MessageArgumentsType>The message arguments class associated with the message type.

◆ findResourceUrl()

String findResourceUrl ( ResourceID  resourceId)

Tries to find Resource URL for Resource ID from this node.

Parameters
resourceIdResource id to find.
Returns
Resource url of resource, can be null if resource was not found.

◆ getAbstractChild()

Node getAbstractChild ( int  index)

Returns node at given child index.

Parameters
indexIndex of the node to get.
Returns
Node at given child index.

◆ getAbstractChildCount()

int getAbstractChildCount ( )

Returns number of child nodes.

Returns
Number of child nodes.

◆ getAbstractChildIndex()

int getAbstractChildIndex ( Node  node)

Returns index of given node in list of child nodes.

Parameters
nodeNode to get child index.
Returns
Index of given node in list of child nodes.

◆ getActualDepth()

float getActualDepth ( )

Gets the value of ActualDepthProperty.

Returns
Current value.

◆ getActualHeight()

float getActualHeight ( )

Gets the value of ActualHeightProperty.

Returns
Current value.

◆ getActualWidth()

float getActualWidth ( )

Gets the value of ActualWidthProperty.

Returns
Current value.

◆ getDepth()

float getDepth ( )

Gets the value of DepthProperty.

Returns
Current value.

◆ getDepthMargin()

Vector2 getDepthMargin ( )

Gets the value of DepthMarginProperty.

Returns
Current value.

◆ getHeight()

float getHeight ( )

Gets the value of HeightProperty.

Returns
Current value.

◆ getHorizontalMargin()

Vector2 getHorizontalMargin ( )

Gets the value of HorizontalMarginProperty.

Returns
Current value.

◆ getLocale()

String getLocale ( )

Gets the value of LocaleProperty.

Returns
Current value.

◆ getName()

String getName ( )

Gets the value of NameProperty.

Returns
Name of the node.

◆ getOpacity()

float getOpacity ( )

Gets the value of OpacityProperty.

Returns
Current value.

◆ getParent()

Node getParent ( )

Gets parent of this node.

Returns
Parent of this node.

◆ getPath()

String getPath ( )

Gets the value of PathProperty.

Returns
Path of the node.

◆ getStateManager()

Resource getStateManager ( )

Gets the value of StateManagerProperty.

Returns
Current value of StateManagerProperty.

◆ getStyle()

Resource getStyle ( )

Gets the value of StyleProperty.

Returns
Current value of the StyleProperty.

◆ getVerticalMargin()

Vector2 getVerticalMargin ( )

Gets the value of VerticalMarginProperty.

Returns
Current value.

◆ getWidth()

float getWidth ( )

Gets the value of WidthProperty.

Returns
Current value.

◆ isAnyChangeFlagSet()

boolean isAnyChangeFlagSet ( EnumSet< PropertyTypeChangeFlag flags)

Checks if any of a set of change flags is set.

Parameters
flagsThe set of flags to check
Returns
True if any of the flags is set, else false.

◆ isAnyChildChangeFlagSet()

boolean isAnyChildChangeFlagSet ( EnumSet< PropertyTypeChangeFlag flags)

Checks if any of a set of change flags is set on a child.

Parameters
flagsThe set of flags to check
Returns
True if any of the flags is set, else false.

◆ isAttached()

boolean isAttached ( )

Checks if node is attached to ui tree.

Returns
Returns true if the node is attached to a ui tree, otherwise false.

◆ isAttaching()

boolean isAttaching ( )

Checks if node is in the process of attaching to ui tree.

Returns
Returns true if the node is in the process of attaching to a ui tree, otherwise false.

◆ isChangeFlagSet()

boolean isChangeFlagSet ( PropertyTypeChangeFlag  flag)

Checks if a change flag is set.

Parameters
flagThe flag to check
Returns
True if the flag is set, else false.

◆ isChildChangeFlagSet()

boolean isChildChangeFlagSet ( PropertyTypeChangeFlag  flag)

Checks if a change flag is set on a child.

Parameters
flagThe flag to check
Returns
True if the flag is set, else false.

◆ isClipChildren()

boolean isClipChildren ( )

Gets the value of ClipChildrenProperty.

Returns
Current value.

◆ isDetaching()

boolean isDetaching ( )

Checks if node is in the process of getting detached from ui tree.

Returns
Returns true if the node is in the process of getting detached from a ui tree, otherwise false.

◆ isEffectivelyEnabled()

boolean isEffectivelyEnabled ( )

Returns whether a node and its ancestor nodes are enabled.

Returns
True if node and its ancestor nodes are enabled.

◆ isEffectivelyFocusable()

boolean isEffectivelyFocusable ( )

Returns whether a node and its ancestor focus scope nodes are focusable.

The ancestor focus scope lookup stops once a popup-type focus scope is reached.

Returns
If the node is focusable, returns true. If the node is in a focus scope that is not focusable, or the node is not focusable, returns false.

◆ isEffectivelyVisible()

boolean isEffectivelyVisible ( )

Returns whether a node and its ancestor nodes are visible.

Returns
True if node and its ancestor nodes are visible.

◆ isEnabled()

boolean isEnabled ( )

Gets the value of EnabledProperty.

Returns
Current value.

◆ isFocusable()

boolean isFocusable ( )

Gets the value of the FocusableProperty.

Returns
Current value.

◆ isFocused()

boolean isFocused ( )

Sets whether a node is an active focus node and can receive keyboard messages.

In a Kanzi application only one node at a time can have active focus. The default value is false.

Returns
Current value of FocusedProperty.

◆ isHitTestable()

boolean isHitTestable ( )

Gets the value of HitTestableProperty.

Returns
Current value.

◆ isHitTestableContainer()

boolean isHitTestableContainer ( )

Gets the value of HitTestableContainerProperty.

Returns
Current value.

◆ isHover()

boolean isHover ( )

Gets the value of HoverProperty.

Returns
Current value.

◆ isInitialized()

boolean isInitialized ( )

Checks if initialize() has been called.

Returns
True if initialize() has been called, false otherwise.

◆ isInvalidArrange()

boolean isInvalidArrange ( )

Check if the node needs arrange.

Returns
True if the arrange change flag is set, else false.

◆ isInvalidDraw()

boolean isInvalidDraw ( )

Tells if node draw flag is invalid.

Returns
True if the Draw change flag is set, else false.

◆ isInvalidFinalTransform()

boolean isInvalidFinalTransform ( )

Tells if final transform flag is invalid for node.

Returns
True if the final transform change flag is set, else false.

◆ isInvalidMeasure()

boolean isInvalidMeasure ( )

Check if the node needs measure.

Returns
True if the measure change flag is set, else false.

◆ isInvalidRender()

boolean isInvalidRender ( )

Returns if node render flag is invalid.

Returns
True if the render change flag is set, else false.

◆ isNamed()

boolean isNamed ( String  name)

Checks if node has a given name.

Parameters
nameName to check.
Returns
True if node name matches the passed argument, otherwise false.

◆ isVisible()

boolean isVisible ( )

Gets the value of VisibleProperty.

Returns
Current value.

◆ iterateNodeComponents()

Iterable<NodeComponent> iterateNodeComponents ( )

Gets an Iterable object used to iterate the Node Components.

Returns
An iterable of Node Components.

◆ lookupNode()

T lookupNode ( String  path)

Returns a node of specified type by looking it up with specified path or alias.

Parameters
pathPath to use for relative lookup.
<T>Type of the node.
Returns
Node that was found, or null if the node was not found.
Exceptions
IllegalArgumentExceptionThrows an IllegalArgumentException if the path is malformed.

◆ lookupNodeComponentByName()

NodeComponent lookupNodeComponentByName ( String  name)

Look up a Node Component by Name.

Parameters
nameThe search name
Returns
The Node Component that has been found, or null if no node component was found.

◆ lookupObject()

KanziObject lookupObject ( String  path)

Returns a KanziObject by looking it up with specified path or alias.

Object found may be another node or a resource within a node.

Parameters
pathRelative path to use for lookup.
Returns
Item found as KanziObject. May be null if no object found.
Exceptions
IllegalArgumentExceptionThrows an IllegalArgumentException if the path is malformed.

◆ removeAbstractChild()

boolean removeAbstractChild ( Node  child)

Removes child node from this node.

Parameters
childChild node to remove.
Returns
True if the operation was successful, otherwise false.

◆ removeAnonymousResource()

void removeAnonymousResource ( Resource  resource)

Removes anonymous resource from object node resources.

Parameters
resourceThe resource to be removed.

◆ removeBinding()

void removeBinding ( AbstractBindingRuntime  bindingRuntime)

Removes a binding runtime added earlier.

Parameters
bindingRuntimeBinding runtime to remove.

◆ removeBindingsWithOwner()

void removeBindingsWithOwner ( KanziObject  owner)

Removes binding runtimes owned by a KanziObject.

Parameters
ownerThe Kanzi Object owning the bindings to be removed.

◆ removeInputManipulator()

void removeInputManipulator ( InputManipulator  inputManipulator)

Detaches an input manipulator from the node.

Parameters
inputManipulatorThe input manipulator to remove.

◆ removeMessageHandler()

void removeMessageHandler ( MessageSubscriptionToken  token)

Removes a message subscription.

Parameters
tokenThe message subscription token which identifies the handler or filter.

◆ removeNodeComponent()

void removeNodeComponent ( NodeComponent  component)

Removes the ownership of a node component from an object node.

Parameters
componentThe component being removed.

◆ removeNodeComponentWithOwner()

void removeNodeComponentWithOwner ( KanziObject  owner)

Removes all node component bindings with the specified owner.

Parameters
ownerThe Kanzi object used as the owner

◆ removeResource()

void removeResource ( ResourceID  resourceId)

Removes a resource with given ID from object node resource dictionary.

Does not do anything if resourceID was not found.

Parameters
resourceIdResource id of resource to remove.

◆ setActualDepth()

void setActualDepth ( float  value)

Sets the value of ActualDepthProperty.

Parameters
valueNew value.

◆ setActualHeight()

void setActualHeight ( float  value)

Sets the value of ActualHeightProperty.

Parameters
valueNew value.

◆ setActualWidth()

void setActualWidth ( float  value)

Sets the value of ActualWidthProperty.

Parameters
valueNew value.

◆ setBinding() [1/3]

AbstractBindingRuntime setBinding ( AbstractBinding  binding)

Sets a binding.

Local precedence is used.

Parameters
bindingBinding to set.
Returns
Binding runtime created for the binding.

◆ setBinding() [2/3]

AbstractBindingRuntime setBinding ( AbstractBinding  binding,
PropertyType<?>  propertyType 
)

Sets a binding.

Local precedence is used.

Parameters
bindingBinding to set.
propertyTypeTarget property type.
Returns
Binding runtime created for the binding.

◆ setBinding() [3/3]

AbstractBindingRuntime setBinding ( AbstractBinding  binding,
PropertyType<?>  propertyType,
PropertyField  propertyField 
)

Sets a binding.

Local precedence is used.

Parameters
bindingBinding to set.
propertyTypeTarget property type.
propertyFieldProperty field.
Returns
Binding runtime created for the binding.

◆ setBindingWithOwner() [1/2]

AbstractBindingRuntime setBindingWithOwner ( AbstractBinding  binding,
KanziObject  owner,
PropertyType<?>  propertyType 
)

Sets a binding with owner.

Local precedence is used.

Parameters
bindingBinding to set.
ownerThe Kanzi Object owning this binding.
propertyTypeTarget property type.
Returns
Binding runtime created for the binding.

◆ setBindingWithOwner() [2/2]

AbstractBindingRuntime setBindingWithOwner ( AbstractBinding  binding,
KanziObject  owner,
PropertyType<?>  propertyType,
PropertyField  propertyField 
)

Sets a binding with owner.

Local precedence is used.

Parameters
bindingBinding to set.
ownerThe Kanzi Object owning this binding.
propertyTypeTarget property type.
propertyFieldProperty field.
Returns
Binding runtime created for the binding.

◆ setChangeFlag()

void setChangeFlag ( PropertyTypeChangeFlag  flag)

Sets a change flag.

Parameters
flagThe flag to set

◆ setClipChildren()

void setClipChildren ( boolean  value)

Sets the value of ClipChildrenProperty.

Parameters
valueNew value.

◆ setDepth()

void setDepth ( float  value)

Sets the value of DepthProperty.

Parameters
valueNew value.

◆ setDepthMargin()

void setDepthMargin ( Vector2  value)

Sets the value of DepthMarginProperty.

Parameters
valueNew value.

◆ setEnabled()

void setEnabled ( boolean  value)

Sets the value of the EnabledProperty.

Parameters
valueNew value.

◆ setFocusable()

void setFocusable ( boolean  value)

Sets the value of the FocusableProperty.

Parameters
valueTo enable a node to get active focus and participate in focus chain navigation, set to true,

◆ setFocused()

void setFocused ( boolean  value)

Sets the value of the FocusedProperty.

Parameters
valueTo set active focus, set to true. To clear focus, set to false.

◆ setHeight()

void setHeight ( float  value)

Sets the value of HeightProperty.

Parameters
valueNew value.

◆ setHitTestable()

void setHitTestable ( boolean  value)

Sets the value of HitTestableProperty.

Parameters
valueNew value.

◆ setHitTestableContainer()

void setHitTestableContainer ( boolean  value)

Sets the value of HitTestableContainerProperty.

Parameters
valueNew value.

◆ setHorizontalMargin()

void setHorizontalMargin ( Vector2  value)

Sets the value of HorizontalMarginProperty.

Parameters
valueNew value.

◆ setHover()

void setHover ( boolean  value)

Sets the value of HoverProperty.

Parameters
valueNew value.

◆ setLocale()

void setLocale ( String  value)

Sets the value of LocaleProperty.

Parameters
valueNew value.

◆ setModifierBinding() [1/2]

AbstractBindingRuntime setModifierBinding ( AbstractBinding  binding,
PropertyType<?>  propertyType 
)

Sets a modifier binding.

As opposed to value source created by setBinding(), creates a property modifier binding.

Parameters
bindingBinding to set.
propertyTypeTarget property type.
Returns
Binding runtime created for the binding.

◆ setModifierBinding() [2/2]

AbstractBindingRuntime setModifierBinding ( AbstractBinding  binding,
PropertyType<?>  propertyType,
PropertyField  propertyField 
)

Sets a modifier binding.

As opposed to value source created by setBinding(), creates a property modifier binding.

Parameters
bindingBinding to set.
propertyTypeTarget property type.
propertyFieldProperty field.
Returns
Binding runtime created for the binding.

◆ setModifierBindingWithOwner() [1/2]

AbstractBindingRuntime setModifierBindingWithOwner ( AbstractBinding  binding,
KanziObject  owner,
PropertyType<?>  propertyType 
)

Sets a modifier binding with owner.

As opposed to value source created by setBinding(), creates a property modifier binding.

Parameters
bindingBinding to set.
ownerThe Kanzi Object owning this binding.
propertyTypeTarget property type.
Returns
Binding runtime created for the binding.

◆ setModifierBindingWithOwner() [2/2]

AbstractBindingRuntime setModifierBindingWithOwner ( AbstractBinding  binding,
KanziObject  owner,
PropertyType<?>  propertyType,
PropertyField  propertyField 
)

Sets a modifier binding with owner.

As opposed to value source created by setBinding(), creates a property modifier binding.

Parameters
bindingBinding to set.
ownerThe Kanzi Object owning this binding.
propertyTypeTarget property type.
propertyFieldProperty field.
Returns
Binding runtime created for the binding.

◆ setName()

void setName ( String  name)

Sets the value of NameProperty.

Parameters
nameNew name to assign.

◆ setOpacity()

void setOpacity ( float  value)

Sets the value of OpacityProperty.

Parameters
valueNew value.

◆ setStateManager()

void setStateManager ( Resource  value)

Sets the value of StateManagerProperty.

Parameters
valueNew value.

◆ setStyle()

void setStyle ( Resource  value)

Sets the value of StyleProperty.

Parameters
valueNew style.

◆ setVerticalMargin()

void setVerticalMargin ( Vector2  value)

Sets the value of VerticalMarginProperty.

Parameters
valueNew value.

◆ setVisible()

void setVisible ( boolean  value)

Sets the value of VisibleProperty.

Parameters
valueNew value.

◆ setWidth()

void setWidth ( float  value)

Sets the value of WidthProperty.

Parameters
valueNew value.

◆ tryAcquireResource()

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.

Parameters
resourceIdName of the resource.
Returns
The acquired resource, or null if the resource id or resource url doesn't map to any resource.

◆ trySetFocus()

Node trySetFocus ( )

Tries to move the focus on this node.

If this node is a focus scope node, this method tries to focus the preserved focus of the focus scope, or tries to focus on the first focusable descendant node of this node.

Returns
If this method successfully moved focus, returns this node or a descendant node of this node. If this method did not move focus, returns null.