Package com.jadice.web.util.icon.client

Class EffectIcons

java.lang.Object

com.jadice.web.util.icon.client.EffectIcons

public final class EffectIcons
extends Object

Method Summary

Modifier and Type	Method	Description
static EffectIcon	getEffectIcon(com.google.gwt.resources.client.ImageResource img)	Get the EffectIcon for a given name.
static EffectIcon	getEffectIcon(com.google.gwt.resources.client.ImageResource img, int effectFlags)	Get the EffectIcon for a given name.
static EffectIcon	getEffectIcon(com.google.gwt.resources.client.ImageResource img, int effectFlags, Dimension targetSize)	Get the EffectIcon for a given name and a set of effect flags scaled to a given dimension.
static EffectIcon	getEffectIcon(Object bundle, String name)	Get the EffectIcon for a given name.
static EffectIcon	getEffectIcon(Object bundle, String name, int effectFlags)	Get the EffectIcon for a given name.
static EffectIcon	getEffectIcon(Object bundle, String name, int effectFlags, Dimension targetSize)	Get the EffectIcon for a given name and a set of effect flags scaled to a given dimension.

Methods inherited from class java.lang.Object

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

Method Details

getEffectIcon

public static EffectIcon getEffectIcon(com.google.gwt.resources.client.ImageResource img)

Get the EffectIcon for a given name. The Icon will have no SFX.

Parameters:

img - the ImageResource containing the raw image data

Returns:

the icon or null if the icon wasn't found.

getEffectIcon

public static EffectIcon getEffectIcon(com.google.gwt.resources.client.ImageResource img,
 int effectFlags)

Get the EffectIcon for a given name. The Icon will have the specified effects.

Parameters:

img - the ImageResource containing the raw image data

effectFlags - an ORed combination of a set of effect flags.

Returns:

the icon or null if the icon wasn't found.

See Also:

• IconManager.AUTO_DISABLE
• IconManager.AUTO_ROLLOVER
• IconManager.EFFECT_ALPHA50P
• IconManager.EFFECT_DARKER
• IconManager.EFFECT_LIGHTER
• IconManager.EFFECT_GRAY

getEffectIcon

public static EffectIcon getEffectIcon(com.google.gwt.resources.client.ImageResource img,
 int effectFlags,
 Dimension targetSize)

Get the EffectIcon for a given name and a set of effect flags scaled to a given dimension.

Parameters:

img - the ImageResource containing the raw image data

effectFlags - an ORed combination of a set of effect flags.

targetSize - the size of the resulting icon

Returns:

the icon or null if the icon wasn't found.

See Also:

• IconManager.AUTO_DISABLE
• IconManager.AUTO_ROLLOVER
• IconManager.EFFECT_ALPHA50P
• IconManager.EFFECT_DARKER
• IconManager.EFFECT_LIGHTER
• IconManager.EFFECT_GRAY

getEffectIcon

public static EffectIcon getEffectIcon(Object bundle,
 String name)

Get the EffectIcon for a given name. The Icon will have no SFX.

Parameters:

bundle - ClientBundle to get the Icon from

name - the icon's name.

Returns:

the icon or null if the icon wasn't found.

getEffectIcon

public static EffectIcon getEffectIcon(Object bundle,
 String name,
 int effectFlags)

Get the EffectIcon for a given name. The Icon will have the specified effects.

Parameters:

bundle - ClientBundle to get the Icon from

name - the icon's name.

effectFlags - an ORed combination of a set of effect flags.

Returns:

the icon or null if the icon wasn't found.

See Also:

• IconManager.AUTO_DISABLE
• IconManager.AUTO_ROLLOVER
• IconManager.EFFECT_ALPHA50P
• IconManager.EFFECT_DARKER
• IconManager.EFFECT_LIGHTER
• IconManager.EFFECT_GRAY

getEffectIcon

public static EffectIcon getEffectIcon(Object bundle,
 String name,
 int effectFlags,
 Dimension targetSize)

Get the EffectIcon for a given name and a set of effect flags scaled to a given dimension.

Parameters:

bundle - ClientBundle to get the Icon from

name - the icon's name.

effectFlags - an ORed combination of a set of effect flags.

targetSize - the size of the resulting icon

Returns:

the icon or null if the icon wasn't found.

See Also:

• IconManager.AUTO_DISABLE
• IconManager.AUTO_ROLLOVER
• IconManager.EFFECT_ALPHA50P
• IconManager.EFFECT_DARKER
• IconManager.EFFECT_LIGHTER
• IconManager.EFFECT_GRAY