org.eclipse.birt.report.model.api.elements.structures

Class EmbeddedImage

java.lang.Object

org.eclipse.birt.report.model.core.Structure

org.eclipse.birt.report.model.core.ReferencableStructure

org.eclipse.birt.report.model.api.elements.structures.EmbeddedImage

All Implemented Interfaces:

java.lang.Cloneable, IStructure, org.eclipse.birt.report.model.core.IPropertySet, org.eclipse.birt.report.model.core.IReferencable

public class EmbeddedImage
extends org.eclipse.birt.report.model.core.ReferencableStructure

Represents an embedded image. The class gives the name and type of the image. Used when an image element ImageItemgives a name. Each embedded image has the following properties:

Name

an embedded image has a unique and required name, so the image item can use the image name to identify an embedded image.

Type

an embedded image has a choice and required type: bmp, gif, png or x-png.

Data

value of the image data in Base64 encoding.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHARSET Encoding mode for the data member.
protected java.lang.String	data String of the image data in 8859_1 encoding.
static java.lang.String	DATA_MEMBER Name of the "data" property.
static java.lang.String	EMBEDDED_IMAGE_STRUCT Name of this structure.
protected java.lang.String	name Value of the name property.
static java.lang.String	NAME_MEMBER Name of the "name" property.
protected java.lang.String	type Value of the expression property.
static java.lang.String	TYPE_MEMBER Name of the "type" property.

Fields inherited from class org.eclipse.birt.report.model.core.ReferencableStructure

clients, clientStructures, LIB_REFERENCE_MEMBER, libReference

Constructor Summary

Constructors

Constructor and Description
EmbeddedImage() Default constructor.
EmbeddedImage(java.lang.String name) Constructs the image with the given name.
EmbeddedImage(java.lang.String name, java.lang.String type) Constructs the image with the required name and type.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getData(org.eclipse.birt.report.model.core.Module module) Returns the image data in Base64 encoding.
protected java.lang.Object	getIntrinsicProperty(java.lang.String propName) Returns the value of a structure property represented as a member variable.
java.lang.String	getName() Returns name of the image.
java.lang.String	getReferencableProperty() Gets the value of the referencable member.
java.lang.String	getStructName() Returns the name of the structure definition.
java.lang.String	getType(org.eclipse.birt.report.model.core.Module module) Returns type value this node represents.
StructureHandle	handle(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.
boolean	isReferencableProperty(java.lang.String memberName) Checks whether the member of the input name is the referencable member or not.
void	setData(byte[] data) Sets the data of the image.
protected void	setIntrinsicProperty(java.lang.String propName, java.lang.Object value) Sets the value of of a structure property represented as a member variable.
void	setName(java.lang.String name) Sets the name of the image.
void	setType(java.lang.String type) Sets the type of the image.
java.util.List	validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validate whether this structure is valid.

Methods inherited from class org.eclipse.birt.report.model.core.ReferencableStructure

addClient, addClientStructure, broadcast, clone, dropClient, dropClientStructure, getClientList, getClientStructures, getLocalProperty, getProperty, hasReferences, isReferencable, updateReference

Methods inherited from class org.eclipse.birt.report.model.core.Structure

checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getStringProperty, isDesignTime, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference

Methods inherited from class java.lang.Object

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

Field Detail

EMBEDDED_IMAGE_STRUCT

public static final java.lang.String EMBEDDED_IMAGE_STRUCT

Name of this structure. Matches the definition in the meta-data dictionary.

See Also:

Constant Field Values

NAME_MEMBER

public static final java.lang.String NAME_MEMBER

Name of the "name" property.

See Also:

Constant Field Values

TYPE_MEMBER

public static final java.lang.String TYPE_MEMBER

Name of the "type" property. It can be:

• IMAGE_TYPE_IMAGE_BMP
• IMAGE_TYPE_IMAGE_GIF
• IMAGE_TYPE_IMAGE_PNG
• IMAGE_TYPE_IMAGE_X_PNG

See Also:

Constant Field Values

DATA_MEMBER

public static final java.lang.String DATA_MEMBER

Name of the "data" property.

See Also:

Constant Field Values

CHARSET

public static final java.lang.String CHARSET

Encoding mode for the data member.

See Also:

Constant Field Values

name

protected java.lang.String name

Value of the name property.

type

protected java.lang.String type

Value of the expression property.

data

protected java.lang.String data

String of the image data in 8859_1 encoding.

Constructor Detail

EmbeddedImage

public EmbeddedImage()

Default constructor.

EmbeddedImage

public EmbeddedImage(java.lang.String name)

Constructs the image with the given name. The type of the image is set to the default value DesignChoiceConstants.IMAGE_TYPE_AUTO.

Parameters:

name - name of the image

EmbeddedImage

public EmbeddedImage(java.lang.String name,
             java.lang.String type)

Constructs the image with the required name and type.

Parameters:

name - name of the image

type - type of the image

Method Detail

getStructName

public java.lang.String getStructName()

Description copied from interface: IStructure

Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.

Returns:

the internal name of the structure a defined in the meta-data dictionary.

getIntrinsicProperty

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)

Description copied from class: org.eclipse.birt.report.model.core.Structure

Returns the value of a structure property represented as a member variable.

Overrides:

getIntrinsicProperty in class org.eclipse.birt.report.model.core.ReferencableStructure

Parameters:

propName - name of the property

Returns:

the value of the property, or null if the property is not set

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                        java.lang.Object value)

Description copied from class: org.eclipse.birt.report.model.core.Structure

Sets the value of of a structure property represented as a member variable.

Overrides:

setIntrinsicProperty in class org.eclipse.birt.report.model.core.ReferencableStructure

Parameters:

propName - the name of the property to set

value - the property value

getName

public java.lang.String getName()

Returns name of the image.

Returns:

name of the image

setName

public void setName(java.lang.String name)

Sets the name of the image.

Parameters:

name - the name to set

getType

public java.lang.String getType(org.eclipse.birt.report.model.core.Module module)

Returns type value this node represents. It can be:

• IMAGE_TYPE_IMAGE_JPEG
• IMAGE_TYPE_IMAGE_BMP
• IMAGE_TYPE_IMAGE_GIF
• IMAGE_TYPE_IMAGE_PNG
• IMAGE_TYPE_IMAGE_X_PNG

Parameters:

module - the module of this structure

Returns:

the type value

setType

public void setType(java.lang.String type)

Sets the type of the image. The allowed values are defined in DesignChoiceConstants, and they are:

• IMAGE_TYPE_IMAGE_JPEG
• IMAGE_TYPE_IMAGE_BMP
• IMAGE_TYPE_IMAGE_GIF
• IMAGE_TYPE_IMAGE_PNG
• IMAGE_TYPE_IMAGE_X_PNG

Parameters:

type - the type to set

getData

public byte[] getData(org.eclipse.birt.report.model.core.Module module)

Returns the image data in Base64 encoding.

Parameters:

module - the module of this structure

Returns:

the image data

setData

public void setData(byte[] data)

Sets the data of the image.

Parameters:

data - the image data to set

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                     int index)

Description copied from class: org.eclipse.birt.report.model.core.Structure

Creates the specific handle of this structure. This handle is always created.

Specified by:

handle in class org.eclipse.birt.report.model.core.Structure

Parameters:

valueHandle - the value handle of this structure list property this structure is in

index - the position of this structure in structure list

Returns:

the handle of this structure.

validate

public java.util.List validate(org.eclipse.birt.report.model.core.Module module,
                      org.eclipse.birt.report.model.core.DesignElement element)

Description copied from class: org.eclipse.birt.report.model.core.Structure

Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance of PropertyValueException.

Overrides:

validate in class org.eclipse.birt.report.model.core.ReferencableStructure

Parameters:

module - the module

element - the element contains this structure

Returns:

the semantic error list

isReferencableProperty

public boolean isReferencableProperty(java.lang.String memberName)

Description copied from class: org.eclipse.birt.report.model.core.ReferencableStructure

Checks whether the member of the input name is the referencable member or not.

Specified by:

isReferencableProperty in class org.eclipse.birt.report.model.core.ReferencableStructure

Parameters:

memberName - the member name to check

Returns:

true if the member with the given name is referencable, otherwise false

getReferencableProperty

public java.lang.String getReferencableProperty()

Description copied from class: org.eclipse.birt.report.model.core.Structure

Gets the value of the referencable member.

Overrides:

getReferencableProperty in class org.eclipse.birt.report.model.core.Structure

Returns:

the value of the referencable member