com.android.ide.common.rendering.api

Class SessionParams

java.lang.Object

com.android.ide.common.rendering.api.RenderParams

com.android.ide.common.rendering.api.SessionParams

public class SessionParams
extends RenderParams

Rendering parameters for a RenderSession.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionParams.Key<T> The class should be in RenderParams, but is here because it was originally here and we cannot change the API without breaking backwards compatibility.
static class	SessionParams.RenderingMode

Field Summary

Fields inherited from class com.android.ide.common.rendering.api.RenderParams

DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
SessionParams(ILayoutPullParser layoutDescription, SessionParams.RenderingMode renderingMode, java.lang.Object projectKey, HardwareConfig hardwareConfig, RenderResources renderResources, LayoutlibCallback layoutlibCallback, int minSdkVersion, int targetSdkVersion, LayoutLog log)
SessionParams(ILayoutPullParser layoutDescription, SessionParams.RenderingMode renderingMode, java.lang.Object projectKey, HardwareConfig hardwareConfig, RenderResources renderResources, LayoutlibCallback projectCallback, int minSdkVersion, int targetSdkVersion, LayoutLog log, int simulatedPlatformVersion)
SessionParams(SessionParams params)

Method Summary

Modifier and Type	Method and Description
void	addAdapterBinding(ResourceReference reference, AdapterBinding data)
java.util.Map<ResourceReference,AdapterBinding>	getAdapterBindings()
boolean	getExtendedViewInfoMode()
ILayoutPullParser	getLayoutDescription()
SessionParams.RenderingMode	getRenderingMode()
int	getSimulatedPlatformVersion()
boolean	isLayoutOnly()
void	setExtendedViewInfoMode(boolean mode)
void	setLayoutOnly() Deprecated. Use RenderSession.measure() instead

Methods inherited from class com.android.ide.common.rendering.api.RenderParams

getActivityName, getAppIcon, getAppLabel, getAssets, getConfigScreenSize, getDensity, getFlag, getHardwareConfig, getImageFactory, getLayoutlibCallback, getLocale, getLog, getMinSdkVersion, getOverrideBgColor, getProjectKey, getResources, getScreenHeight, getScreenWidth, getTargetSdkVersion, getTimeout, getXdpi, getYdpi, isBgColorOverridden, isForceNoDecor, isQuickStepEnabled, isRtlSupported, setActivityName, setAppIcon, setAppLabel, setAssetRepository, setFlag, setForceNoDecor, setImageFactory, setLocale, setOverrideBgColor, setQuickStep, setRtlSupport, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionParams

public SessionParams(ILayoutPullParser layoutDescription,
                     SessionParams.RenderingMode renderingMode,
                     java.lang.Object projectKey,
                     HardwareConfig hardwareConfig,
                     RenderResources renderResources,
                     LayoutlibCallback layoutlibCallback,
                     int minSdkVersion,
                     int targetSdkVersion,
                     LayoutLog log)

Parameters:

layoutDescription - the ILayoutPullParser letting the LayoutLib Bridge visit the layout file.

renderingMode - The rendering mode.

projectKey - An Object identifying the project. This is used for the cache mechanism.

hardwareConfig - the HardwareConfig.

renderResources - a RenderResources object providing access to the resources.

layoutlibCallback - The LayoutlibCallback object to get information from the project.

minSdkVersion - the minSdkVersion of the project

targetSdkVersion - the targetSdkVersion of the project

log - the object responsible for displaying warning/errors to the user.

SessionParams

public SessionParams(ILayoutPullParser layoutDescription,
                     SessionParams.RenderingMode renderingMode,
                     java.lang.Object projectKey,
                     HardwareConfig hardwareConfig,
                     RenderResources renderResources,
                     LayoutlibCallback projectCallback,
                     int minSdkVersion,
                     int targetSdkVersion,
                     LayoutLog log,
                     int simulatedPlatformVersion)

Parameters:

layoutDescription - the ILayoutPullParser letting the LayoutLib Bridge visit the layout file.

renderingMode - The rendering mode.

projectKey - An Object identifying the project. This is used for the cache mechanism.

hardwareConfig - the HardwareConfig.

renderResources - a RenderResources object providing access to the resources.

projectCallback - The LayoutlibCallback object to get information from the project.

minSdkVersion - the minSdkVersion of the project

targetSdkVersion - the targetSdkVersion of the project

log - the object responsible for displaying warning/errors to the user.

simulatedPlatformVersion - try to simulate an old android platform. 0 means disabled.

SessionParams

public SessionParams(SessionParams params)

Method Detail

getLayoutDescription

public ILayoutPullParser getLayoutDescription()

getRenderingMode

public SessionParams.RenderingMode getRenderingMode()

setLayoutOnly

public void setLayoutOnly()

Deprecated. Use RenderSession.measure() instead

isLayoutOnly

public boolean isLayoutOnly()

addAdapterBinding

public void addAdapterBinding(ResourceReference reference,
                              AdapterBinding data)

getAdapterBindings

public java.util.Map<ResourceReference,AdapterBinding> getAdapterBindings()

setExtendedViewInfoMode

public void setExtendedViewInfoMode(boolean mode)

getExtendedViewInfoMode

public boolean getExtendedViewInfoMode()

getSimulatedPlatformVersion

public int getSimulatedPlatformVersion()