com.android.ide.common.rendering.api

Class RenderParams

java.lang.Object

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

Direct Known Subclasses:

DrawableParams, SessionParams

public abstract class RenderParams
extends java.lang.Object

Base class for rendering parameters. This include the generic parameters but not what needs to be rendered or additional parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
RenderParams(java.lang.Object projectKey, HardwareConfig hardwareConfig, RenderResources renderResources, LayoutlibCallback layoutlibCallback, int minSdkVersion, int targetSdkVersion, LayoutLog log)
RenderParams(RenderParams params) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActivityName()
ResourceValue	getAppIcon() Returns the application icon resource, or null if there is no icon.
java.lang.String	getAppLabel() Returns the application label, or null if there is no label.
AssetRepository	getAssets()
ScreenSize	getConfigScreenSize() Deprecated. Use getHardwareConfig()
Density	getDensity() Deprecated. Use getHardwareConfig()
<T> T	getFlag(SessionParams.Key<T> key)
float	getFontScale() Returns the user preference for the font scaling factor.
HardwareConfig	getHardwareConfig()
IImageFactory	getImageFactory()
LayoutlibCallback	getLayoutlibCallback()
java.lang.String	getLocale()
LayoutLog	getLog()
int	getMinSdkVersion()
int	getOverrideBgColor() Deprecated. background color may only be overridden with transparent background. If for some reason in the future one wants to override background with a specific color one can do it in studio and drawing the image with transparent background on top.
java.lang.Object	getProjectKey()
RenderResources	getResources()
int	getScreenHeight() Deprecated. Use getHardwareConfig()
int	getScreenWidth() Deprecated. Use getHardwareConfig()
int	getTargetSdkVersion()
long	getTimeout()
float	getXdpi() Deprecated. Use getHardwareConfig()
float	getYdpi() Deprecated. Use getHardwareConfig()
boolean	isBgColorOverridden() Deprecated. use isTransparentBackground() instead
boolean	isForceNoDecor()
boolean	isQuickStepEnabled()
boolean	isRtlSupported()
boolean	isTransparentBackground()
void	setActivityName(java.lang.String activityName)
void	setAppIcon(ResourceValue appIcon) Sets the application icon resource, or null if there is no icon.
void	setAppLabel(java.lang.String appLabel) Sets the application label, or null if there is no label.
void	setAssetRepository(AssetRepository assetRepository)
<T> void	setFlag(SessionParams.Key<T> key, T value)
void	setFontScale(float fontScale) Sets user preference for the scaling factor for fonts, relative to the base density scaling.
void	setForceNoDecor()
void	setImageFactory(IImageFactory imageFactory)
void	setLocale(java.lang.String locale)
void	setQuickStep(boolean quickStep) Enables/disables the quick step mode in the device.
void	setRtlSupport(boolean supportsRtl)
void	setTimeout(long timeout)
void	setTransparentBackground()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

RenderParams

public RenderParams(java.lang.Object projectKey,
                    HardwareConfig hardwareConfig,
                    RenderResources renderResources,
                    LayoutlibCallback layoutlibCallback,
                    int minSdkVersion,
                    int targetSdkVersion,
                    LayoutLog log)

Parameters:

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.

RenderParams

public RenderParams(RenderParams params)

Copy constructor.

Method Detail

setTransparentBackground

public void setTransparentBackground()

setTimeout

public void setTimeout(long timeout)

setImageFactory

public void setImageFactory(IImageFactory imageFactory)

setAppIcon

public void setAppIcon(@Nullable
                       ResourceValue appIcon)

Sets the application icon resource, or null if there is no icon.

setAppLabel

public void setAppLabel(@Nullable
                        java.lang.String appLabel)

Sets the application label, or null if there is no label. The label string has to be resolved and should not require further resource resolution.

setLocale

public void setLocale(java.lang.String locale)

setActivityName

public void setActivityName(java.lang.String activityName)

setForceNoDecor

public void setForceNoDecor()

setRtlSupport

public void setRtlSupport(boolean supportsRtl)

setAssetRepository

public void setAssetRepository(AssetRepository assetRepository)

setQuickStep

public void setQuickStep(boolean quickStep)

Enables/disables the quick step mode in the device. When enabled, this will hide the recents button and show the quick step home button.

setFontScale

public void setFontScale(float fontScale)

Sets user preference for the scaling factor for fonts, relative to the base density scaling. See android.content.res.Configuration#fontScale

getFontScale

public float getFontScale()

Returns the user preference for the font scaling factor. See android.content.res.Configuration#fontScale

getProjectKey

public java.lang.Object getProjectKey()

getHardwareConfig

public HardwareConfig getHardwareConfig()

getMinSdkVersion

public int getMinSdkVersion()

getTargetSdkVersion

public int getTargetSdkVersion()

getScreenWidth

@Deprecated
public int getScreenWidth()

Deprecated. Use getHardwareConfig()

getScreenHeight

@Deprecated
public int getScreenHeight()

Deprecated. Use getHardwareConfig()

getDensity

@Deprecated
public Density getDensity()

Deprecated. Use getHardwareConfig()

getXdpi

@Deprecated
public float getXdpi()

Deprecated. Use getHardwareConfig()

getYdpi

@Deprecated
public float getYdpi()

Deprecated. Use getHardwareConfig()

getResources

public RenderResources getResources()

getAssets

public AssetRepository getAssets()

getLayoutlibCallback

public LayoutlibCallback getLayoutlibCallback()

getLog

public LayoutLog getLog()

isTransparentBackground

public boolean isTransparentBackground()

Returns:

if the background color should be transparent (in contrast to match the window theme background color).

isBgColorOverridden

@Deprecated
public boolean isBgColorOverridden()

Deprecated. use isTransparentBackground() instead

getOverrideBgColor

@Deprecated
public int getOverrideBgColor()

Deprecated. background color may only be overridden with transparent background. If for some reason in the future one wants to override background with a specific color one can do it in studio and drawing the image with transparent background on top.

getTimeout

public long getTimeout()

getImageFactory

public IImageFactory getImageFactory()

getConfigScreenSize

@Deprecated
public ScreenSize getConfigScreenSize()

Deprecated. Use getHardwareConfig()

getAppIcon

@Nullable
public final ResourceValue getAppIcon()

Returns the application icon resource, or null if there is no icon.

getAppLabel

@Nullable
public final java.lang.String getAppLabel()

Returns the application label, or null if there is no label. The label is already resolved and does not require further resource resolution.

getLocale

public final java.lang.String getLocale()

getActivityName

public final java.lang.String getActivityName()

isForceNoDecor

public final boolean isForceNoDecor()

isRtlSupported

public final boolean isRtlSupported()

isQuickStepEnabled

public final boolean isQuickStepEnabled()

setFlag

public <T> void setFlag(SessionParams.Key<T> key,
                        T value)

getFlag

public <T> T getFlag(SessionParams.Key<T> key)