com.android.ide.common.rendering.api

Class RenderResources

java.lang.Object

com.android.ide.common.rendering.api.RenderResources

public class RenderResources
extends java.lang.Object

A class containing all the resources needed to do a rendering.

This contains both the project specific resources and the framework resources, and provide convenience methods to resolve resource and theme references.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderResources.FrameworkResourceIdProvider Deprecated. This class will be removed after layoutlib is updated. Use RenderResources.ResourceIdProvider
static class	RenderResources.ResourceIdProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REFERENCE_EMPTY
static java.lang.String	REFERENCE_NULL
static java.lang.String	REFERENCE_UNDEFINED

Constructor Summary

Constructors

Constructor and Description
RenderResources()

Method Summary

Modifier and Type	Method and Description
void	applyStyle(StyleResourceValue theme, boolean useAsPrimary) Use this theme to resolve resources.
void	clearStyles() Clear all the themes applied with applyStyle(StyleResourceValue, boolean)
ResourceValue	dereference(ResourceValue resourceValue) Searches for a ResourceValue referenced by the given value.
ResourceValue	findItemInStyle(StyleResourceValue style, ResourceReference attr) Returns the ResourceValue matching a given attribute in a given style.
ResourceValue	findItemInStyle(StyleResourceValue style, java.lang.String attrName, boolean isFrameworkAttr) Deprecated. Use findItemInStyle(StyleResourceValue, ResourceReference).
ResourceValue	findItemInTheme(ResourceReference attr) Returns the ResourceValue for a given attr in the all themes returned by getAllThemes().
ResourceValue	findItemInTheme(java.lang.String attrName, boolean isFrameworkAttr) Deprecated. Use findItemInTheme(ResourceReference).
ResourceValue	findResValue(java.lang.String reference, boolean forceFrameworkOnly) Deprecated. Use dereference(ResourceValue) instead, to provide context necessary to handle namespaces correctly, like the "current" namespace or namespace prefix lookup logic. Alternatively, use getUnresolvedResource(ResourceReference) or getResolvedResource(ResourceReference) if you already know exactly what you're looking for.
java.util.List<StyleResourceValue>	getAllThemes() Returns a list of StyleResourceValue containing a list of themes to be used for resolving resources.
StyleResourceValue	getCurrentTheme() Deprecated. Use getDefaultTheme() or getAllThemes()
StyleResourceValue	getDefaultTheme() Returns the StyleResourceValue representing the default theme.
ResourceValue	getFrameworkResource(ResourceType resourceType, java.lang.String resourceName) Deprecated. Use getResolvedResource(ResourceReference)
StyleResourceValue	getParent(StyleResourceValue style) Returns the parent style of the given style, if any
ResourceValue	getProjectResource(ResourceType resourceType, java.lang.String resourceName) Deprecated. Use getResolvedResource(ResourceReference)
ResourceValue	getResolvedResource(ResourceReference reference) Returns a resource by namespace, type and name.
StyleResourceValue	getStyle(ResourceReference reference) Returns the style matching the given reference.
StyleResourceValue	getStyle(java.lang.String styleName, boolean isFramework) Deprecated. Use getStyle(ResourceReference)
StyleResourceValue	getTheme(java.lang.String name, boolean frameworkTheme) Deprecated. Use getStyle(ResourceReference)
ResourceValue	getUnresolvedResource(ResourceReference reference) Returns a resource by namespace, type and name.
ResourceValue	resolveResValue(ResourceValue value) Returns the "final" ResourceValue referenced by the value of value.
ResourceValue	resolveValue(ResourceType type, java.lang.String name, java.lang.String value, boolean isFrameworkValue) Deprecated. Use resolveResValue(ResourceValue)
void	setFrameworkResourceIdProvider(RenderResources.FrameworkResourceIdProvider provider) Deprecated. This method will be removed after layoutlib is updated. Use setFrameworkResourceIdProvider(ResourceIdProvider)
void	setFrameworkResourceIdProvider(RenderResources.ResourceIdProvider provider)
void	setLogger(LayoutLog logger)
boolean	themeIsParentOf(StyleResourceValue parentTheme, StyleResourceValue childTheme) Returns whether a theme is a parent of a given theme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REFERENCE_NULL

public static final java.lang.String REFERENCE_NULL

See Also:

Constant Field Values

REFERENCE_EMPTY

public static final java.lang.String REFERENCE_EMPTY

See Also:

Constant Field Values

REFERENCE_UNDEFINED

public static final java.lang.String REFERENCE_UNDEFINED

See Also:

Constant Field Values

Constructor Detail

RenderResources

public RenderResources()

Method Detail

setFrameworkResourceIdProvider

public void setFrameworkResourceIdProvider(RenderResources.ResourceIdProvider provider)

setFrameworkResourceIdProvider

@Deprecated
public void setFrameworkResourceIdProvider(RenderResources.FrameworkResourceIdProvider provider)

Deprecated. This method will be removed after layoutlib is updated. Use setFrameworkResourceIdProvider(ResourceIdProvider)

setLogger

public void setLogger(LayoutLog logger)

getCurrentTheme

@Deprecated
public StyleResourceValue getCurrentTheme()

Deprecated. Use getDefaultTheme() or getAllThemes()

Returns the StyleResourceValue representing the current theme.

Returns:

the theme or null if there is no current theme.

getDefaultTheme

public StyleResourceValue getDefaultTheme()

Returns the StyleResourceValue representing the default theme.

applyStyle

public void applyStyle(StyleResourceValue theme,
                       boolean useAsPrimary)

Use this theme to resolve resources.

Remember to call clearStyles() to clear the applied styles, so the default theme may be restored.

Parameters:

theme - The style to use for resource resolution in addition to the the default theme and the styles applied earlier. If null, the operation is a no-op.

useAsPrimary - If true, the theme is used first to resolve attributes. If false, the theme is used if the resource cannot be resolved using the default theme and all the themes that have been applied prior to this call.

clearStyles

public void clearStyles()

Clear all the themes applied with applyStyle(StyleResourceValue, boolean)

getAllThemes

public java.util.List<StyleResourceValue> getAllThemes()

Returns a list of StyleResourceValue containing a list of themes to be used for resolving resources. The order of the themes in the list specifies the order in which they should be used to resolve resources.

getTheme

@Deprecated
public StyleResourceValue getTheme(java.lang.String name,
                                               boolean frameworkTheme)

Deprecated. Use getStyle(ResourceReference)

Returns a theme by its name.

themeIsParentOf

public boolean themeIsParentOf(StyleResourceValue parentTheme,
                               StyleResourceValue childTheme)

Returns whether a theme is a parent of a given theme.

Parameters:

parentTheme - the parent theme

childTheme - the child theme.

Returns:

true if the parent theme is indeed a parent theme of the child theme.

getFrameworkResource

@Deprecated
public ResourceValue getFrameworkResource(ResourceType resourceType,
                                                      java.lang.String resourceName)

Deprecated. Use getResolvedResource(ResourceReference)

Returns a framework resource by type and name. The returned resource is resolved.

Parameters:

resourceType - the type of the resource

resourceName - the name of the resource

getProjectResource

@Deprecated
public ResourceValue getProjectResource(ResourceType resourceType,
                                                    java.lang.String resourceName)

Deprecated. Use getResolvedResource(ResourceReference)

Returns a project resource by type and name. The returned resource is resolved.

Parameters:

resourceType - the type of the resource

resourceName - the name of the resource

findItemInTheme

@Nullable
public ResourceValue findItemInTheme(@NonNull
                                               ResourceReference attr)

Returns the ResourceValue for a given attr in the all themes returned by getAllThemes(). If the item is not directly available in the a theme, its parent theme is used before checking the next theme from the list.

findItemInTheme

@Nullable
 @Deprecated
public final ResourceValue findItemInTheme(java.lang.String attrName,
                                                                  boolean isFrameworkAttr)

Deprecated. Use findItemInTheme(ResourceReference).

findItemInStyle

@Nullable
public ResourceValue findItemInStyle(@NonNull
                                               StyleResourceValue style,
                                               @NonNull
                                               ResourceReference attr)

Returns the ResourceValue matching a given attribute in a given style. If the item is not directly available in the style, the method looks in its parent style.

findItemInStyle

@Nullable
 @Deprecated
public final ResourceValue findItemInStyle(StyleResourceValue style,
                                                                  java.lang.String attrName,
                                                                  boolean isFrameworkAttr)

Deprecated. Use findItemInStyle(StyleResourceValue, ResourceReference).

findResValue

@Nullable
 @Deprecated
public final ResourceValue findResValue(@Nullable
                                                               java.lang.String reference,
                                                               boolean forceFrameworkOnly)

Deprecated. Use dereference(ResourceValue) instead, to provide context necessary to handle namespaces correctly, like the "current" namespace or namespace prefix lookup logic. Alternatively, use getUnresolvedResource(ResourceReference) or getResolvedResource(ResourceReference) if you already know exactly what you're looking for.

dereference

@Nullable
public ResourceValue dereference(@NonNull
                                           ResourceValue resourceValue)

Searches for a ResourceValue referenced by the given value. This method doesn't perform recursive resolution, so the returned ResourceValue (if not null) may be just another reference.

References to theme attributes is supported and resolved against the theme from getDefaultTheme(). For more details see Referencing style attributes

Unlike resolveResValue(ResourceValue), this method returns null if the input is not a reference (i.e. doesn't start with '@' or '?').

Parameters:

resourceValue - the value to dereference. Its namespace and namespace lookup logic are used to handle namespaces when interpreting the textual value. The type is ignored and will not affect the type of the returned value.

See Also:

resolveResValue(ResourceValue)

getUnresolvedResource

@Nullable
public ResourceValue getUnresolvedResource(ResourceReference reference)

Returns a resource by namespace, type and name. The returned resource is unresolved.

getResolvedResource

@Nullable
public ResourceValue getResolvedResource(ResourceReference reference)

Returns a resource by namespace, type and name. The returned resource is resolved, as defined in resolveResValue(ResourceValue).

See Also:

resolveResValue(ResourceValue)

resolveValue

@Nullable
 @Deprecated
public ResourceValue resolveValue(ResourceType type,
                                                         java.lang.String name,
                                                         java.lang.String value,
                                                         boolean isFrameworkValue)

Deprecated. Use resolveResValue(ResourceValue)

Kept for layoutlib. Remove ASAP.

resolveResValue

@Nullable
public ResourceValue resolveResValue(@Nullable
                                               ResourceValue value)

Returns the "final" ResourceValue referenced by the value of value.

This method ensures that the returned ResourceValue object is not a valid reference to another resource. It may be just a leaf value (e.g. "#000000") or a reference that could not be dereferenced.

If a value that does not need to be resolved is given, the method will return the input value.

Parameters:

value - the value containing the reference to resolve.

Returns:

a ResourceValue object or null

getParent

public StyleResourceValue getParent(StyleResourceValue style)

Returns the parent style of the given style, if any

Parameters:

style - the style to look up

Returns:

the parent style, or null

getStyle

@Deprecated
public final StyleResourceValue getStyle(java.lang.String styleName,
                                                     boolean isFramework)

Deprecated. Use getStyle(ResourceReference)

Returns the style matching the given name. The name should not contain any namespace prefix.

Parameters:

styleName - Name of the style. For example, "Widget.ListView.DropDown".

Returns:

the {link StyleResourceValue} for the style, or null if not found.

getStyle

@Nullable
public StyleResourceValue getStyle(@NonNull
                                             ResourceReference reference)

Returns the style matching the given reference.