com.android.ide.common.rendering.api

Class LayoutlibCallback

java.lang.Object

com.android.ide.common.rendering.api.LayoutlibCallback

All Implemented Interfaces:

IProjectCallback, XmlParserFactory

public abstract class LayoutlibCallback
extends java.lang.Object
implements IProjectCallback, XmlParserFactory

Intermediary class implementing parts of both the old and new ProjectCallback from the LayoutLib API.

Even newer LayoutLibs use this directly instead of the the interface. This allows the flexibility to add newer methods without having to update LayoutLib API version.

Nested Class Summary

Nested classes/interfaces inherited from interface com.android.ide.common.rendering.api.IProjectCallback

IProjectCallback.ViewAttribute

Constructor Summary

Constructors

Constructor and Description
LayoutlibCallback()

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	findClass(java.lang.String name) Finds a custom class in the project.
<T> T	getFlag(SessionParams.Key<T> key) A callback to query arbitrary data.
ResourceNamespace.Resolver	getImplicitNamespaces() Returns an optional ResourceNamespace.Resolver that knows namespace prefixes assumed to be declared in every resource file.
boolean	hasAndroidXAppCompat() Returns true if the module depends on androidx.appcompat.
boolean	hasLegacyAppCompat() Returns true if the module depends on android.support.v7.appcompat.
boolean	isResourceNamespacingRequired() Returns true if the module uses namespaced resources.
java.lang.Object	loadClass(java.lang.String name, java.lang.Class[] constructorSignature, java.lang.Object[] constructorArgs) Like IProjectCallback.loadView(String, Class[], Object[]), but intended for loading classes that may not be custom views.
abstract boolean	supports(int ideFeature) Returns if the IDE supports the requested feature.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.ide.common.rendering.api.IProjectCallback

getActionBarCallback, getAdapterBinding, getAdapterItemValue, getNamespace, getOrGenerateResourceId, getParser, loadView, resolveResourceId

Methods inherited from interface com.android.ide.common.rendering.api.XmlParserFactory

createXmlParser, createXmlParserForFile, createXmlParserForPsiFile

Constructor Detail

LayoutlibCallback

public LayoutlibCallback()

Method Detail

loadClass

public java.lang.Object loadClass(@NonNull
                                  java.lang.String name,
                                  @Nullable
                                  java.lang.Class[] constructorSignature,
                                  @Nullable
                                  java.lang.Object[] constructorArgs)
                           throws java.lang.ClassNotFoundException

Like IProjectCallback.loadView(String, Class[], Object[]), but intended for loading classes that may not be custom views.

Parameters:

name - className in binary format (see ClassLoader)

Returns:

an new instance created by calling the given constructor.

Throws:

java.lang.ClassNotFoundException - any exceptions thrown when creating the instance is wrapped in ClassNotFoundException.

Since:

API 15

supports

public abstract boolean supports(int ideFeature)

Returns if the IDE supports the requested feature.

Since:

API 15

See Also:

Features

getFlag

@Nullable
public <T> T getFlag(@NonNull
                               SessionParams.Key<T> key)

A callback to query arbitrary data. This is similar to RenderParams.setFlag(SessionParams.Key, Object). The main difference is that when using this, the IDE doesn't have to compute the value in advance and thus may save on some computation.

Since:

API 15

findClass

@NonNull
public java.lang.Class<?> findClass(@NonNull
                                             java.lang.String name)
                                      throws java.lang.ClassNotFoundException

Finds a custom class in the project.

Like loadClass(String, Class[], Object[]), but doesn't instantiate an object and just returns the class found.

Parameters:

name - className in binary format. (see ClassLoader.

Throws:

java.lang.ClassNotFoundException

Since:

API 15

getImplicitNamespaces

@NonNull
public ResourceNamespace.Resolver getImplicitNamespaces()

Returns an optional ResourceNamespace.Resolver that knows namespace prefixes assumed to be declared in every resource file.

For backwards compatibility, in non-namespaced projects this contains the "tools" prefix mapped to ResourceNamespace.TOOLS. Before the IDE understood resource namespaces, this prefix was used for referring to sample data, even if the user didn't define the "tools" prefix using xmlns:tools="...".

In namespaced projects this method returns an empty resolver, which means sample data won't work without an explicit definition of a namespace prefix for the ResourceNamespace.TOOLS URI.

hasLegacyAppCompat

public boolean hasLegacyAppCompat()

Returns true if the module depends on android.support.v7.appcompat.

hasAndroidXAppCompat

public boolean hasAndroidXAppCompat()

Returns true if the module depends on androidx.appcompat.

isResourceNamespacingRequired

public boolean isResourceNamespacingRequired()

Returns true if the module uses namespaced resources.