com.softwareag.mobile.runtime.toolkit.ui

Class ImageElement

java.lang.Object

com.softwareag.mobile.runtime.nui.nUIObject

com.softwareag.mobile.runtime.nui.nUIDisplayObject

com.softwareag.mobile.runtime.nui.nUIElementDisplay

com.softwareag.mobile.runtime.nui.nUIImageElement

com.softwareag.mobile.runtime.toolkit.ui.ImageElement

public class ImageElement
extends com.softwareag.mobile.runtime.nui.nUIImageElement

The ImageElement is an extension of nUIImageElement which encapsulates handling of highlight images. To change the current state of the underlying image, use:

 final ImageElement element = ...;
 // show the default image
 element.unhighlight();
 // show the highlight image
 element.highlight();
 

In addition it provides methods to scale both images relative to it's parent's dimensions:

 final ImageElement element = ...;
 element.scaleToMatchParent();
 element.scaleToParentWidth();
 element.scaleToParentHeight();
 

Version:

9.10.0.0000-0158

Field Summary

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIElementDisplay

Y_IDENTIFIER_PREV_BOTTOM

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIDisplayObject

COLOR_BACKGROUND_NORMAL, COLOR_BLACK, COLOR_FOREGROUND_DARK, COLOR_FOREGROUND_LIGHT, COLOR_FOREGROUND_NORMAL, COLOR_TRANSPARENT, COLOR_WHITE, DIMENSIONS_IDENTIFIER_PARENT_DIMENSIONS

Fields inherited from class com.softwareag.mobile.runtime.nui.nUIObject

event_listener, event_listener_exclusive, first_child, last_child, next_sibling, nuiid, parent, prev_sibling, unlink_children_on_removal_from_parent

Constructor Summary

Constructors

Constructor and Description
ImageElement(int nuiid, javax.microedition.lcdui.Image image) Creates this ImageElement with a default image.
ImageElement(int nuiid, javax.microedition.lcdui.Image image, javax.microedition.lcdui.Image highlightImage) Creates this ImageElement with a default and highlight image.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(com.softwareag.mobile.runtime.nui.nUIEventListener listener, boolean exclusive) Adds a new event-listener, replacing any previously defined listener
void	applyDefaultImage(javax.microedition.lcdui.Image image) Sets and displays the default image.
javax.microedition.lcdui.Image	getHighlightImage() Returns the highlight image.
void	highlight() Show's the highlight image if it's not null.
void	removeEventListener(com.softwareag.mobile.runtime.nui.nUIEventListener listener) Removes an existing event-listener
void	scaleToMatchParent() Scales both images to match the parent's dimensions.
void	scaleToParentHeight() Scales both images to match the parent's height.
void	scaleToParentWidth() Scales both images to match the parent's width.
void	setDefaultImage(javax.microedition.lcdui.Image image) Sets the default image.
void	setHighlightImage(javax.microedition.lcdui.Image highlightImage) Sets the highlight image.
void	unhighlight() Show's the default image.

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIImageElement

getAlign, getHeight, getImage, getInnerWidth, getInnerX, setAlign, setImage

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIElementDisplay

getY, insertAt

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIDisplayObject

getBgcolor, getBottom, getFocus, getFocusable, getGesturable, getInnerHeight, getInnerY, getLeft, getMaxChildX, getMaxChildY, getRight, getScreenInnerX, getScreenInnerY, getScreenX, getScreenY, getTop, getTopLevelParentView, getTopLevelParentWindow, getTriggerable, getWidth, getX, insertAtInternal, isEnabled, remove, setBgcolor, setBottom, setChildFocus, setEnabled, setFocus, setFocusable, setGesturable, setHeight, setInnerHeight, setInnerWidth, setInnerX, setInnerY, setLeft, setRight, setTop, setTriggerable, setWidth, setX, setY

Methods inherited from class com.softwareag.mobile.runtime.nui.nUIObject

add, childElementAt, childIndexOf, insertAfter, insertBefore, outputChildHierarchy, remove, replace, replace

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageElement

public ImageElement(int nuiid,
                    javax.microedition.lcdui.Image image)

Creates this ImageElement with a default image.

Parameters:

nuiid -

image -

ImageElement

public ImageElement(int nuiid,
                    javax.microedition.lcdui.Image image,
                    javax.microedition.lcdui.Image highlightImage)

Creates this ImageElement with a default and highlight image.

Parameters:

nuiid -

image -

highlightImage -

Method Detail

getHighlightImage

public javax.microedition.lcdui.Image getHighlightImage()

Returns the highlight image.

Returns:

setHighlightImage

public void setHighlightImage(javax.microedition.lcdui.Image highlightImage)

Sets the highlight image.

Parameters:

highlightImage -

setDefaultImage

public void setDefaultImage(javax.microedition.lcdui.Image image)

Sets the default image.

Parameters:

image -

applyDefaultImage

public void applyDefaultImage(javax.microedition.lcdui.Image image)

Sets and displays the default image.

Parameters:

image -

scaleToMatchParent

public void scaleToMatchParent()

Scales both images to match the parent's dimensions.

scaleToParentWidth

public void scaleToParentWidth()

Scales both images to match the parent's width.

scaleToParentHeight

public void scaleToParentHeight()

Scales both images to match the parent's height.

highlight

public void highlight()

Show's the highlight image if it's not null.

unhighlight

public void unhighlight()

Show's the default image.

addEventListener

public void addEventListener(com.softwareag.mobile.runtime.nui.nUIEventListener listener,
                             boolean exclusive)

Description copied from class: com.softwareag.mobile.runtime.nui.nUIObject

Adds a new event-listener, replacing any previously defined listener

Overrides:

addEventListener in class com.softwareag.mobile.runtime.nui.nUIObject

Parameters:

listener - The new listener

exclusive - If only this listener should be called (not the generic listener)

removeEventListener

public void removeEventListener(com.softwareag.mobile.runtime.nui.nUIEventListener listener)

Description copied from class: com.softwareag.mobile.runtime.nui.nUIObject

Removes an existing event-listener

Overrides:

removeEventListener in class com.softwareag.mobile.runtime.nui.nUIObject

Parameters:

listener - The listener to remove