Kanzi 3.9.16
PortalView Class Reference

Portal node. More...

Inheritance diagram for PortalView:
[legend]

Static Public Member Functions

static ObjectRef< PortalView > create (Domain domain, String name)
 Creates a Portal node.
 
static ObjectRef< PortalView > create (Domain domain, String name, float width, float height)
 Creates a Portal node.
 

Static Public Attributes

static final Metaclass 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 setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
 Sets the flag to indicate that the property was loaded from KZB.
 
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.
 
- 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

Portal node.

Member Function Documentation

◆ create() [1/2]

static ObjectRef< PortalView > create ( Domain domain,
String name )
static

Creates a Portal node.

Parameters
domainUI domain to use.
nameNode name.

◆ create() [2/2]

static ObjectRef< PortalView > create ( Domain domain,
String name,
float width,
float height )
static

Creates a Portal node.

Parameters
domainUI domain to use.
nameNode name.
widthNode width.
heightNode height.

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.PortalViewMetadata.metaclass

The Metaclass for the class.