Kanzi  3.9.6
Java API
ExclusiveActivityHostConceptMetadata Interface Reference

Metadata definitions for ExclusiveActivityHostConcept. More...

Inheritance diagram for ExclusiveActivityHostConceptMetadata:
[legend]

Classes

class  ImplicitActivityChangeRequestMessageArguments
 Metadata definitions for ImplicitActivityChangeRequestMessageArguments. More...
 

Public Attributes

DynamicPropertyType< String > ActivationPathProperty
 
DynamicPropertyType< String > ActiveActivityProperty
 
DynamicPropertyType< String > ExclusiveActivityHostContentProperty
 Describes the content of an Exclusive Activity Host node. More...
 
DynamicPropertyType< Integer > FocusOnActivatingActivityProperty
 Sets the policy that this Exclusive Activity Host uses to decide whether it tries to set the key focus to its activating Activity: More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ExclusiveActivityHostConcept")
 Metaclass for ExclusiveActivityHostConcept.
 
DynamicMessageType< ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments > NavigateNextMessageMessage
 Navigates to the next Activity in an Exclusive Activity Host. More...
 
DynamicMessageType< ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments > NavigatePreviousMessageMessage
 Navigates to the previous Activity in an Exclusive Activity Host. More...
 

Detailed Description

Metadata definitions for ExclusiveActivityHostConcept.

Member Data Documentation

◆ ActivationPathProperty

DynamicPropertyType<String> ActivationPathProperty
Initial value:
=
new DynamicPropertyType<>("ExclusiveActivityHostConcept.ActivationPath", String.class)

◆ ActiveActivityProperty

DynamicPropertyType<String> ActiveActivityProperty
Initial value:
=
new DynamicPropertyType<>("ExclusiveActivityHostConcept.ActiveActivity", String.class)

◆ ExclusiveActivityHostContentProperty

DynamicPropertyType<String> ExclusiveActivityHostContentProperty
Initial value:
= new DynamicPropertyType<>(
"ExclusiveActivityHostConcept.ExclusiveActivityHostContent", String.class)

Describes the content of an Exclusive Activity Host node.

An Exclusive Activity Host uses the value of this property to instantiate Activity prefabs and control the status and lifetime of its child Activities. Kanzi Studio user cannot directly edit this property. The ActivityBrowserController sets the value of this property according to the changes done to the state of the Activity Tree in the ActivityBrowser. The expected format for the property value is the name of the Activity that the Exclusive Activity Host initially activates, followed by a list of Activity descriptions. Each of this Activity description contains: The name of the Activity

  • The ControllerProperty reference value of the Activity
  • The path to the prefab of that Activity. The values in this property must be separated by a comma. For example, {name0,{name1,666,path1},{name2,123,path2}}.

◆ FocusOnActivatingActivityProperty

DynamicPropertyType<Integer> FocusOnActivatingActivityProperty
Initial value:
= new DynamicPropertyType<>(
"ExclusiveActivityHostConcept.FocusOnActivatingActivity", Integer.class)

Sets the policy that this Exclusive Activity Host uses to decide whether it tries to set the key focus to its activating Activity:

  • When Host Has Focus: If the Activity Host has the focus, it tries to set the focus to the Activity. This is the default.
  • Always: The Activity Host always tries to set the focus to the Activity.
  • Never: The Activity Host never tries to set the focus to the Activity.

◆ NavigateNextMessageMessage

DynamicMessageType< ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments> NavigateNextMessageMessage
Initial value:
=
new DynamicMessageType<>("ExclusiveActivityHostConcept.NavigateNextMessage",
ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments
.class)

Navigates to the next Activity in an Exclusive Activity Host.

◆ NavigatePreviousMessageMessage

DynamicMessageType< ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments> NavigatePreviousMessageMessage
Initial value:
=
new DynamicMessageType<>("ExclusiveActivityHostConcept.NavigatePreviousMessage",
ExclusiveActivityHostConceptMetadata.ImplicitActivityChangeRequestMessageArguments
.class)

Navigates to the previous Activity in an Exclusive Activity Host.