com.saperion.ngc.resultset

Class CustomIcon

java.lang.Object

com.saperion.ngc.resultset.CustomIcon

public final class CustomIcon
extends Object

Utility class used to handle custom icons in result list.

Method Summary

Modifier and Type	Method and Description
static boolean	exists(String customIcon) Checks if a custom icon with the specified name exists in the custom-icons folder.
static org.zkoss.zul.Image	getImage(String customIcon) Return an Image containing the custom image.
static org.zkoss.zul.Image	updateImage(String customIcon, org.zkoss.zul.Image image) Updates the content of the provided image with the specified custom icon.

Methods inherited from class java.lang.Object

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

Method Detail

exists

public static boolean exists(String customIcon)

Checks if a custom icon with the specified name exists in the custom-icons folder.

Parameters:

customIcon - the value contained in SYSCUSTOMICONNAME. Can contain path and extension. Only the base-name of the file will be used to check if the icon exists.

Returns:

true if icon exists

getImage

public static org.zkoss.zul.Image getImage(String customIcon)

Return an Image containing the custom image. If the custom image does not exist, an empty image is returned.

Parameters:

customIcon - the custom icon to load as image

Returns:

image with custom icon or empty image

updateImage

public static org.zkoss.zul.Image updateImage(String customIcon,
                                              org.zkoss.zul.Image image)

Updates the content of the provided image with the specified custom icon. If no matching custom icon was found, the original image is returned.

Parameters:

customIcon - custom icon to load

image - image to update

Returns:

updated image