Kanzi 3.9.10
ResourceDictionarySelector Class Reference

A resource dictionary selector is a type of a resource dictionary that redirects resource queries to its only nested dictionary. More...

Inheritance diagram for ResourceDictionarySelector:
[legend]

Static Public Member Functions

static< T extends KanziObject > ObjectRef< T > create (Domain domain, String name)
 Creates a resource dictionary selector.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from ResourceDictionary
static final Metaclass metaclass = ResourceDictionaryProxy.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from ResourceDictionaryProxy
static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Resource
static final Metaclass 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 ResourceDictionary
ObjectRef< Resourceacquire (ResourceID key)
 Gets from the resource dictionary the resource with the resource ID that you pass to the function.
 
ResourceManager.AcquireTask acquireAsync (ResourceID key, ResourceManager.AcquireTask.Callback callback)
 Asynchronously acquires a resource.
 
void add (ResourceDictionary resourceDictionary)
 Adds a nested resource dictionary to a resource dictionary.
 
void add (ResourceID key, Resource resource)
 Adds a resource ID to a resource mapping to a resource dictionary.
 
void add (ResourceID key, String url)
 Adds a resource ID to a resource URL mapping to a resource dictionary.
 
void addAnonymousResource (Resource resource)
 Adds an anonymous resource to a resource dictionary.
 
ObjectRef< ResourceDictionaryclone ()
 Duplicates a resource dictionary.
 
boolean contains (ResourceID key)
 Returns whether a resource dictionary contains a mapping for the resource ID that you pass to the function.
 
String find (ResourceID key)
 Resolves the mapping from the resource ID that you pass to the function to the URL of the resource.
 
ResourceDictionary findDictionary (String name)
 Searches for a nested dictionary with the specified name and returns a pointer to it.
 
Resource findStoredResource (ResourceID key)
 Finds an explicitly stored resource pointer from a dictionary.
 
int getDictionaryCount ()
 Gets the number of nested resource dictionaries in a resource dictionary.
 
Iterable< ResourceiterateAnonymousResources ()
 Returns an Iterable object that you can use to iterate the anonymous resources stored by this resource dictionary object.
 
Iterable< UrlMapPairiterateUrls ()
 Returns an Iterable object that you can use to iterate elements of the URL mappings container.
 
void merge (ResourceDictionary preferredDictionary)
 Copies into this resource dictionary the contents of the resource dictionary that you pass to the function.
 
void remove (ResourceID key)
 Removes a resource ID mapping from a resource dictionary.
 
void removeAnonymousResource (Resource resource)
 Removes an anonymous resource from the resource dictionary.
 
void removeDictionary (int index)
 Removes a nested resource dictionary from a resource dictionary.
 
Iterable< ResourceDictionaryreverseIterateNestedResourceDictionaries ()
 Returns an Iterable object that you can use to iterate nested resource dictionary container in reversed order.
 
- Public Member Functions inherited from Resource
String getName ()
 Gets the resource name.
 
String getUrl ()
 Gets the resource URL.
 
void setKeepAlive (boolean keepAlive)
 Sets the keep alive flag.
 
- 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< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Public Attributes inherited from ResourceMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Resource")
 Metaclass for Resource.
 
- Public Attributes inherited from ResourceDictionaryMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ResourceDictionary")
 Metaclass for ResourceDictionary.
 
- Public Attributes inherited from ResourceDictionarySelectorMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ResourceDictionarySelector")
 Metaclass for ResourceDictionarySelector.
 
DynamicPropertyType< ResourceSelectedDictionaryProperty
 The currently selected theme in the theme group.
 

Detailed Description

A resource dictionary selector is a type of a resource dictionary that redirects resource queries to its only nested dictionary.

This type of dictionary is used internally by Screen to implement switching of locales and themes in theme groups. You can use Screen.setLocale to set the current locale and Screen.activateTheme to activate a theme in a theme group.

Member Function Documentation

◆ create()

static< T extends KanziObject > ObjectRef< T > create ( Domain domain,
String name )
static

Creates a resource dictionary selector.

Parameters
domainThe domain to which the resource dictionary selector belongs.
nameThe name of the resource dictionary selector.
Returns
The handle to the resource dictionary selector.

Reimplemented from ResourceDictionaryProxy.

Member Data Documentation

◆ metaclass

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

The Metaclass for the class.