All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.hi.customizer.beans.scci.SCImage

public interface SCImage
extends SCCustomComponent
This interface provides access to images on the CustomTerminal Bean.

See Also:
SCButtonVV, SCImageButton, SCWebLink

Variable Index

 o BOTH
Constant for setLayoutType() Will scale both horizontally and vertically to fit the image exactly to the the size of the SCImage; possible distortion, no clipping.
 o HORIZONTAL
Constant for setLayoutType() Will scale horizontally; possible distortion, possible clipping.
 o NONE
Constant for setLayoutType() Will not scale; no distortion, possible clipping.
 o TOFIT
Constant for setLayoutType() Will scale both horizontally and vertically; no distortion, no clipping.
 o VERTICAL
Constant for setLayoutType() Will scale vertically; possible distortion, possible clipping.

Method Index

 o getDisplayImage()
Gets the current image exactly as it is displayed.
 o getImage()
Gets the current image prior to any scaling or clipping.
 o getImageFileName()
Gets the name of the file being displayed.
 o getLayoutType()
Gets the layout type
 o setImage(Image)
Sets the image to be displayed using the current layout setting.
 o setImage(Image, int)
Sets the image to be displayed using the given layout setting.
 o setImageFileName(String)
Sets the image to be displayed using the current layout setting.
 o setImageFileName(String, int)
Sets the image to be displayed using the specified layout setting.
 o setLayoutType(int)
Sets the layoutType parameter.

Variables

 o NONE
 public static final int NONE
Constant for setLayoutType() Will not scale; no distortion, possible clipping.

See Also:
setLayoutType
 o BOTH
 public static final int BOTH
Constant for setLayoutType() Will scale both horizontally and vertically to fit the image exactly to the the size of the SCImage; possible distortion, no clipping.

See Also:
setLayoutType
 o TOFIT
 public static final int TOFIT
Constant for setLayoutType() Will scale both horizontally and vertically; no distortion, no clipping.

See Also:
setLayoutType
 o HORIZONTAL
 public static final int HORIZONTAL
Constant for setLayoutType() Will scale horizontally; possible distortion, possible clipping.

See Also:
setLayoutType
 o VERTICAL
 public static final int VERTICAL
Constant for setLayoutType() Will scale vertically; possible distortion, possible clipping.

See Also:
setLayoutType

Methods

 o setImageFileName
 public abstract void setImageFileName(String fileName)
Sets the image to be displayed using the current layout setting.

Parameters:
fileName - the name of the image file
See Also:
getImageFileName, getLayoutType, setLayoutType
 o setImageFileName
 public abstract void setImageFileName(String fileName,
                                       int layoutType)
Sets the image to be displayed using the specified layout setting.

Parameters:
fileName - the name of the image file
layoutType - the layout type
See Also:
getImageFileName, setLayoutType
 o getImageFileName
 public abstract String getImageFileName()
Gets the name of the file being displayed.

Returns:
the file name
See Also:
setImageFileName
 o setImage
 public abstract void setImage(Image image)
Sets the image to be displayed using the current layout setting.

Parameters:
image - the image to display
See Also:
getImage
 o setImage
 public abstract void setImage(Image image,
                               int layoutType)
Sets the image to be displayed using the given layout setting.

Parameters:
image - the image to display
layoutType - the layout code
See Also:
getImage, setLayoutType
 o getImage
 public abstract Image getImage()
Gets the current image prior to any scaling or clipping.

Returns:
the current image prior to any scaling or clipping
 o getDisplayImage
 public abstract Image getDisplayImage()
Gets the current image exactly as it is displayed.

Returns:
the current image exactly as it is displayed
See Also:
setImage
 o setLayoutType
 public abstract void setLayoutType(int layoutType)
Sets the layoutType parameter.

Parameters:
layoutType - the layout code
See Also:
getLayoutType, NONE, BOTH, TOFIT, HORIZONTAL, VERTICAL
 o getLayoutType
 public abstract int getLayoutType()
Gets the layout type

Returns:
the current layout type setting
See Also:
setLayoutType, NONE, BOTH, TOFIT, HORIZONTAL, VERTICAL

All Packages  Class Hierarchy  This Package  Previous  Next  Index