wt.clients.util
Interface IconCacheIF

All Known Implementing Classes:

IconCache

public interface IconCacheIF

Supported API: true

Extendable: true

Method Summary

Image	getOpenIcon(Class windchillClass) Method getStandardIcon returns an icon for a Windchill business class Supported API: false
Image	getOpenIcon(WTObject busObj) Method getStandardIcon returns an icon for a Windchill business object with the appropriate glyphs added as overlays.
String[]	getOpenIconHREF(Class windchillClass, URLFactory urlfactory, String glyph_type) Method getStandardIconHREF returns an String[0] HREF to the icon for a Windchill business object.
Image	getStandardIcon(Class windchillClass) Method getStandardIcon returns an icon for a Windchill business class Supported API: false
Image	getStandardIcon(IconSelector iconselector) Method getStandardIcon returns an icon for a Windchill business class Supported API: false
Image	getStandardIcon(WTObject busObj) Method getStandardIcon returns an icon for a Windchill business object with the appropriate glyphs added as overlays.
String[]	getStandardIconHREF(Class windchillClass, URLFactory urlfactory, String glyph_type) Method getStandardIconHREF returns an String[0] HREF to the icon for a Windchill business object.
Image	mergeImages(Image main_image, Image glyph_image) Method mergeImages creates a single image by overlaying a given transparent glyph adornment on top of a main image.
Image	mergeImages(Image main_image, Vector glyphs) Method mergeImages creates a single image by overlaying the given transparent glyph adornments on top of a main image.

Method Detail

getStandardIconHREF

public String[] getStandardIconHREF(Class windchillClass,
                                    URLFactory urlfactory,
                                    String glyph_type)
                             throws WTException,
                                    IllegalAccessException,
                                    InvocationTargetException,
                                    InterruptedException,
                                    PropertyVetoException

Method getStandardIconHREF returns an String[0] HREF to the icon for a Windchill business object. If a glyph is required, it's href is String[1].

Supported API: false

Parameters:

windchillClass - The Class to look up the icon for.

urlfactory -

glyph_type - Identifier for the type of glyph to superimpose over the Image. Such as RevisionControlledIconDelegate.CHECKED_OUT. If this value is null, there is no glyph to superimpose over the Image.

Returns:

String[]

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getOpenIconHREF

public String[] getOpenIconHREF(Class windchillClass,
                                URLFactory urlfactory,
                                String glyph_type)
                         throws WTException,
                                IllegalAccessException,
                                InvocationTargetException,
                                InterruptedException,
                                PropertyVetoException

Method getStandardIconHREF returns an String[0] HREF to the icon for a Windchill business object. If a glyph is required, it's href is String[1].

Supported API: false

Parameters:

windchillClass - The Class to look up the icon for.

urlfactory -

glyph_type - Identifier for the type of glyph to superimpose over the Image. Such as RevisionControlledIconDelegate.CHECKED_OUT. If this value is null, there is no glyph to superimpose over the Image.

Returns:

String[]

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getStandardIcon

public Image getStandardIcon(WTObject busObj)
                      throws WTException,
                             IllegalAccessException,
                             InvocationTargetException,
                             InterruptedException,
                             PropertyVetoException

Method getStandardIcon returns an icon for a Windchill business object with the appropriate glyphs added as overlays.

Supported API: false

Parameters:

busObj - The WTObject that the icon will be returned for placing the appropriate glyphs on top of the main image for the class.

Returns:

Image

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getOpenIcon

public Image getOpenIcon(WTObject busObj)
                  throws WTException,
                         IllegalAccessException,
                         InvocationTargetException,
                         InterruptedException,
                         PropertyVetoException

Method getStandardIcon returns an icon for a Windchill business object with the appropriate glyphs added as overlays.

Supported API: false

Parameters:

busObj - The WTObject that the icon will be returned for placing the appropriate glyphs on top of the main image for the class.

Returns:

Image

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getStandardIcon

public Image getStandardIcon(Class windchillClass)
                      throws WTException,
                             IllegalAccessException,
                             InvocationTargetException,
                             InterruptedException,
                             PropertyVetoException

Method getStandardIcon returns an icon for a Windchill business class

Supported API: false

Parameters:

windchillClass - The Class to look up the icon for

Returns:

Image

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getOpenIcon

public Image getOpenIcon(Class windchillClass)
                  throws WTException,
                         IllegalAccessException,
                         InvocationTargetException,
                         InterruptedException,
                         PropertyVetoException

Method getStandardIcon returns an icon for a Windchill business class

Supported API: false

Parameters:

windchillClass - The Class to look up the icon for

Returns:

Image

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

getStandardIcon

public Image getStandardIcon(IconSelector iconselector)
                      throws WTException,
                             IllegalAccessException,
                             InvocationTargetException,
                             InterruptedException,
                             PropertyVetoException

Method getStandardIcon returns an icon for a Windchill business class

Supported API: false

Parameters:

iconselector - The IconSelector is used in to look up the icon, this is part of the Icon Delegation throughout Windchill.

Returns:

Image

Throws:

WTException

IllegalAccessException

InvocationTargetException

InterruptedException

PropertyVetoException

mergeImages

public Image mergeImages(Image main_image,
                         Image glyph_image)
                  throws InterruptedException

Method mergeImages creates a single image by overlaying a given transparent glyph adornment on top of a main image. This method assumes that the first Image parameter is the main image and the second Image parameter is the glyph adornment. This method verifies that the images are loaded before attempting to create the new image.

Parameters:

main_image - the main Image onto which a glyph is placed.

glyph_image - The glyph Image which is placed on top of the main image.

Returns:

Image

Throws:

InterruptedException

mergeImages

public Image mergeImages(Image main_image,
                         Vector glyphs)
                  throws InterruptedException

Method mergeImages creates a single image by overlaying the given transparent glyph adornments on top of a main image. This method assumes that the first Image parameter is the main image and the second parameter is a Vector of Images which are all glyphs to be used in adorning the main image. This method verifies that the images are loaded before attempting to create the new image.

Parameters:

main_image - the main Image onto which a glyph is placed.

glyphs - The glyph Image which is placed on top of the main image.

Returns:

Image

Throws:

InterruptedException