ReadOnlyPenProps

extends PenProps

java.lang.Object
↳	com.htc.painting.tool.pen.PenProps
	↳	com.htc.painting.tool.pen.ReadOnlyPenProps

Class Overview

Read-only pen properties. Can't be modified.

Summary

[Expand]

Inherited Constants

From class com.htc.painting.tool.pen.PenProps

int	FLAG_IS_DEFAULT_PEN	Flag which is used at KEY_FLAGS Set it to KEY_FLAGS if this pen is the default pen
int	FLAG_IS_ERASER	Flag which is used at KEY_FLAGS Set it to KEY_FLAGS if this pen is an eraser
int	FLAG_IS_HIGHLIGHTER	Flag which is used at KEY_FLAGS Set it to KEY_FLAGS if this pen is the default pen
int	FLAG_IS_RENDER_SUPPLIER	Flag which is used at KEY_FLAGS Set it to KEY_FLAGS if this pen is also an interface of IRenderSupplier
int	FLAG_IS_SKIA_SIMPLE_PEN	Flag which is used at KEY_FLAGS Set it to KEY_FLAGS if this pen is a simple pen
String	KEY_APP_PACKAGENAME	The application package name which is written at AndroidManifest.xml Type: String Require Field: true
String	KEY_BACKGROUND_RESID	The pen background image resource id Type: int Require Field: false
String	KEY_COLOR_ADJUSTABLE	The user can change pen width or not Type: boolean Require Field: true Default Value: true
String	KEY_COLOR_DEFAULT	The default pen color Type: int Require Field: true Default Value: Color.BLACK
String	KEY_DISPLAY_NAME_RESID	The pen display name resource id Type: long Require Field: true
String	KEY_FIXED_WIDTH_ARRAY	Current pen tool box only support 5 width, if this value is set, PIM will use these width values Type: float[] Require Field: false
String	KEY_FLAGS	Some basic flags Type: int Require Field: true Default Value: 0x0000
String	KEY_PEN_CLASSNAME	The classname which inherits com.htc.painting.tool.pen.Pen Type: String Require Field: true
String	KEY_PEN_DISABLE_IMAGE_RESID	The pen disable image resource id Type: int Require Field: false
String	KEY_PEN_NAME	The pen unique name Type: String Require Field: true
String	KEY_SUPPORTED_COLOR_ARRAY	if this value is set, PIM will use these color values only Type: int[] Require Field: false
String	KEY_THUMBNAIL_RESID	The pen thumbnail resource id Type: int Require Field: false
String	KEY_TRANSPARENCY_ADJUSTABLE	The user can adjust pen transparency or not Type: boolean Require Field: true Default Value: false
String	KEY_TRANSPARENCY_ALPHA_DEFAULT	The transparency alpha value Type: int Require Field: true Default Value: 0 Value: 0-255 (follow skia design)
String	KEY_VERSION	This pen version, we can use this version info to know that we shall use new pen to replace old pen or not.
String	KEY_WIDTH_ADJUSTABLE	The user can change pen width or not Type: boolean Require Field: true Default Value: true
String	KEY_WIDTH_DEFAULT	The default pen width Type: float Require Field: true Default Value: 25
String	KEY_WIDTH_MAX	The maximum available pen width Type: float Require Field: true Default Value: 20
String	KEY_WIDTH_MIN	The minimum available pen width Type: float Require Field: true Default Value: 1

[Expand]

Inherited Fields

From class com.htc.painting.tool.pen.PenProps

Public Constructors
	ReadOnlyPenProps() Default constructor
	ReadOnlyPenProps(byte[] bProperties) Constructor with binary property map
	ReadOnlyPenProps(PenProps ppb) Constructor with PenProps

Protected Methods
final void	put(String key, Serializable value) Inserts a value into the mapping of this Bundle, replacing any existing value for the given key.

[Expand]

Inherited Methods

From class com.htc.painting.tool.pen.PenProps

void	checkMissingKeyAndTypes() Make sure that all key which is declared at this class has been set.
boolean	containsKey(String key) This key has been set or not
boolean	equals(Object object) Compares the specified object to this instance, and returns `true` if the specified object is a PenProps and both PenProps contain the same PenProps.
boolean	getBoolean(String key) Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
boolean	getBoolean(String key, boolean defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
boolean[]	getBooleanArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
byte	getByte(String key) Returns the value associated with the given key, or (byte) 0 if no mapping of the desired type exists for the given key.
Byte	getByte(String key, byte defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
byte[]	getByteArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
char	getChar(String key) Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
char	getChar(String key, char defaultValue) Returns the value associated with the given key, or (char) 0 if no mapping of the desired type exists for the given key.
char[]	getCharArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
double	getDouble(String key) Returns the value associated with the given key, or 0.0 if no mapping of the desired type exists for the given key.
double	getDouble(String key, double defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
double[]	getDoubleArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
float	getFloat(String key) Returns the value associated with the given key, or 0.0f if no mapping of the desired type exists for the given key.
float	getFloat(String key, float defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
float[]	getFloatArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
int	getInt(String key, int defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
int	getInt(String key) Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
int[]	getIntArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
long	getLong(String key) Returns the value associated with the given key, or 0L if no mapping of the desired type exists for the given key.
long	getLong(String key, long defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
long[]	getLongArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
short	getShort(String key) Returns the value associated with the given key, or (short) 0 if no mapping of the desired type exists for the given key.
short	getShort(String key, short defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
short[]	getShortArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
String	getString(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
String[]	getStringArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
void	put(String key, Serializable value) Inserts a value into the mapping of this Bundle, replacing any existing value for the given key.
void	putBoolean(String key, boolean value) Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key.
void	putBooleanArray(String key, boolean[] value) Inserts a boolean array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putByte(String key, byte value) Inserts a byte value into the mapping of this Bundle, replacing any existing value for the given key.
void	putByteArray(String key, byte[] value) Inserts a byte array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putChar(String key, char value) Inserts a char value into the mapping of this Bundle, replacing any existing value for the given key.
void	putCharArray(String key, char[] value) Inserts a char array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putDouble(String key, double value) Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.
void	putDoubleArray(String key, double[] value) Inserts a double array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putFloat(String key, float value) Inserts a float value into the mapping of this Bundle, replacing any existing value for the given key.
void	putFloatArray(String key, float[] value) Inserts a float array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putInt(String key, int value) Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.
void	putIntArray(String key, int[] value) Inserts an int array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putLong(String key, long value) Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.
void	putLongArray(String key, long[] value) Inserts a long array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putShort(String key, short value) Inserts a short value into the mapping of this Bundle, replacing any existing value for the given key.
void	putShortArray(String key, short[] value) Inserts a short array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putString(String key, String value) Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key.
void	putStringArray(String key, String[] value) Inserts a String array value into the mapping of this Bundle, replacing any existing value for the given key.
void	removeIfExist(String key) Remove specific key if exist
int	size() Returns the number of mappings.
byte[]	toByteArray() Transform key-value data into byte array

From class java.lang.Object

Public Constructors

public ReadOnlyPenProps ()

Since: API Level 2.0

Default constructor

public ReadOnlyPenProps (byte[] bProperties)

Since: API Level 2.0

Constructor with binary property map

Parameters

bProperties	a byte[], or null

public ReadOnlyPenProps (PenProps ppb)

Since: API Level 2.0

Constructor with PenProps

Protected Methods

protected final void put (String key, Serializable value)

Since: API Level 2.0

Inserts a value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters

key	a String, or null

Throws

PenException

Classes

Exceptions

ReadOnlyPenProps

Class Overview

Summary

Public Constructors

public ReadOnlyPenProps ()

public ReadOnlyPenProps (byte[] bProperties)

Parameters

public ReadOnlyPenProps (PenProps ppb)

Protected Methods

protected final void put (String key, Serializable value)

Parameters

Throws