com.goldencode.p2j.ui.ocx

Class ListImages

java.lang.Object

com.goldencode.p2j.comauto.ComObject

com.goldencode.p2j.ui.ocx.ComInterface

com.goldencode.p2j.ui.ocx.ListImages

All Implemented Interfaces:

IImages, Deletable, WrappedResource

public class ListImages
extends ComInterface
implements IImages

A server side implementation of IImages COM interface

Author:

mag

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<comhandle>	images Lists all images
private java.util.Map<java.lang.String,comhandle>	keysToImages Maps keys to target images

Fields inherited from class com.goldencode.p2j.ui.ocx.ComInterface

parent

Fields inherited from class com.goldencode.p2j.comauto.ComObject

includeUnannotatedMethods, LOGGER, methodTable, propertyTable

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ListImages(GenericWidget parent) Constructor.

Method Summary

Modifier and Type	Method and Description
comhandle	add(ComParameter index, ComParameter key, ComParameter picture) Adds a ListImage object to a ListImages and returns a reference to the created object.
comhandle	add(integer index, character key, comhandle picture) Adds a ListImage object to a ListImages and returns a reference to the created object.
void	clear() Remove all objects in a collection.
(package private) int	findIndex(comhandle imageReference) Finds an image position within this images list.
(package private) java.lang.String	findKey(comhandle imageReference) Finds an image key.
private java.util.Map.Entry<java.lang.String,comhandle>	findKeyValueEntry(comhandle imageReference) Finds an image key and reference pair.
integer	getCount() Returns the number of objects in a collection.
comhandle	getItem(character key) Returns a specific member of a Collection either by key.
comhandle	getItem(NumberType index) Returns a specific member of a Collection either by position.
private comhandle	item(int index) Returns the image comhandle reference by the given 1-based index.
private comhandle	item(java.lang.String key) Returns the image comhandle reference by the given image key.
static handle	newInstance(GenericWidget parent) Factory method.
void	remove(character key) Remove a specific member of a collection.
void	remove(int index) Remove a specific member of a collection.
void	remove(NumberType index) Remove a specific member of a collection.
void	remove(java.lang.String key) Remove a specific member of a collection.
void	setCount(integer count) Set the number of objects in a collection.

Methods inherited from class com.goldencode.p2j.ui.ocx.ComInterface

delete, getActivexName, getName, valid

Methods inherited from class com.goldencode.p2j.comauto.ComObject

call, chainCall, checkParameters, deref, destroy, getComObjectClass, getComObjectInstance, getParentControlFrame, getParentProcedure, getProperty, id, id, init, marshal, ref, setName, setParentControlFrame, setProperty, unknown, unmarshal, unmarshal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

keysToImages

private java.util.Map<java.lang.String,comhandle> keysToImages

Maps keys to target images

images

private java.util.List<comhandle> images

Lists all images

Constructor Detail

ListImages

private ListImages(GenericWidget parent)

Constructor.

Parameters:

parent - Parent widget.

Method Detail

newInstance

public static handle newInstance(GenericWidget parent)

Factory method.

Parameters:

parent - The image list parent widget.

Returns:

The new instance wrapped by comhandle.

add

public comhandle add(integer index,
                     character key,
                     comhandle picture)

Adds a ListImage object to a ListImages and returns a reference to the created object.

Specified by:

add in interface IImages

Parameters:

index - position inside collection.

key - Key unique value to identify an image

picture - The picture object reference wrapped in comhandle.

Returns:

comhandle to the new created image.

add

public comhandle add(ComParameter index,
                     ComParameter key,
                     ComParameter picture)

Adds a ListImage object to a ListImages and returns a reference to the created object.

Specified by:

add in interface IImages

Parameters:

index - The position inside collection, wrapped in ComParameter

key - The key to identify an image, wrapped in ComParameter

picture - The picture object reference, wrapped in ComParameter.

Returns:

The comhandle to the new created image.

getItem

public comhandle getItem(NumberType index)

Returns a specific member of a Collection either by position.

Specified by:

getItem in interface IImages

Parameters:

index - Collection position

Returns:

The image handle at requested position or unknown if not found.

item

private comhandle item(int index)

Returns the image comhandle reference by the given 1-based index.

Parameters:

index - The given 1-based index

Returns:

The image comhandle reference

getItem

public comhandle getItem(character key)

Returns a specific member of a Collection either by key.

Specified by:

getItem in interface IImages

Parameters:

key - Key unique value to identify a picture

Returns:

Picture at requested key or unknown if not found.

item

private comhandle item(java.lang.String key)

Returns the image comhandle reference by the given image key.

Parameters:

key - The given image key

Returns:

The image comhandle reference

clear

public void clear()

Remove all objects in a collection.

Specified by:

clear in interface IImages

getCount

public integer getCount()

Returns the number of objects in a collection.

Specified by:

getCount in interface IImages

Returns:

Number of objects in a collection.

setCount

public void setCount(integer count)

Set the number of objects in a collection.

Specified by:

setCount in interface IImages

Parameters:

count - New size of collection

remove

public void remove(NumberType index)

Remove a specific member of a collection.

Specified by:

remove in interface IImages

Parameters:

index - position inside collection.

remove

public void remove(int index)

Remove a specific member of a collection.

Parameters:

index - position inside collection, 1-based index.

remove

public void remove(character key)

Remove a specific member of a collection.

Specified by:

remove in interface IImages

Parameters:

key - The image key

remove

public void remove(java.lang.String key)

Remove a specific member of a collection.

Parameters:

key - The image key

findKey

java.lang.String findKey(comhandle imageReference)

Finds an image key.

Parameters:

imageReference - The target image reference

Returns:

The image key

findIndex

int findIndex(comhandle imageReference)

Finds an image position within this images list.

Parameters:

imageReference - The target image reference

Returns:

The image 0-based position within this images list

findKeyValueEntry

private java.util.Map.Entry<java.lang.String,comhandle> findKeyValueEntry(comhandle imageReference)

Finds an image key and reference pair.

Parameters:

imageReference - The target image reference

Returns:

The image key and reference pair