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

All Superinterfaces:
SCCustomComponent
All Known Subinterfaces:
SCButtonVV, SCImageButton, SCWebLink

public interface SCImage
extends SCCustomComponent

This interface provides access to images on the CustomTerminal Bean.

See Also:
SCButtonVV, SCImageButton, SCWebLink

Field Summary
static 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.
static int HORIZONTAL
          Constant for setLayoutType() Will scale horizontally; possible distortion, possible clipping.
static int NONE
          Constant for setLayoutType() Will not scale; no distortion, possible clipping.
static int TOFIT
          Constant for setLayoutType() Will scale both horizontally and vertically; no distortion, no clipping.
static int VERTICAL
          Constant for setLayoutType() Will scale vertically; possible distortion, possible clipping.
 
Method Summary
 java.awt.Image getDisplayImage()
          Gets the current image exactly as it is displayed.
 java.awt.Image getImage()
          Gets the current image prior to any scaling or clipping.
 java.lang.String getImageFileName()
          Gets the name of the file being displayed.
 int getLayoutType()
          Gets the layout type
 void setImage(java.awt.Image image)
          Sets the image to be displayed using the current layout setting.
 void setImage(java.awt.Image image, int layoutType)
          Sets the image to be displayed using the given layout setting.
 void setImageFileName(java.lang.String fileName)
          Sets the image to be displayed using the current layout setting.
 void setImageFileName(java.lang.String fileName, int layoutType)
          Sets the image to be displayed using the specified layout setting.
 void setLayoutType(int layoutType)
          Sets the layoutType parameter.
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCCustomComponent
getBackgroundColor, getCaption, getForegroundColor, getGlobalRead, getGlobalWrite, getHelpCaption, getHostLinkLength, getHostLinkPosition, getTabNumber, hasFocus, isTempHidden, isVisible, readGlobalVariable, requestFocus, setBackgroundColor, setCaption, setForegroundColor, setGlobalRead, setGlobalWrite, setHelpCaption, setTempHidden, setVisible, toString, writeGlobalVariable
 

Field Detail

NONE

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

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(int)

TOFIT

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

HORIZONTAL

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

VERTICAL

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

setImageFileName

public void setImageFileName(java.lang.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(int)

setImageFileName

public void setImageFileName(java.lang.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(int)

getImageFileName

public java.lang.String getImageFileName()
Gets the name of the file being displayed.
Returns:
the file name
See Also:
setImageFileName(java.lang.String)

setImage

public void setImage(java.awt.Image image)
Sets the image to be displayed using the current layout setting.
Parameters:
image - the image to display
See Also:
getImage()

setImage

public void setImage(java.awt.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(int)

getImage

public java.awt.Image getImage()
Gets the current image prior to any scaling or clipping.
Returns:
the current image prior to any scaling or clipping

getDisplayImage

public java.awt.Image getDisplayImage()
Gets the current image exactly as it is displayed.
Returns:
the current image exactly as it is displayed
See Also:
setImage(java.awt.Image)

setLayoutType

public void setLayoutType(int layoutType)
Sets the layoutType parameter.
Parameters:
layoutType - the layout code
See Also:
getLayoutType(), NONE, BOTH, TOFIT, HORIZONTAL, VERTICAL

getLayoutType

public int getLayoutType()
Gets the layout type
Returns:
the current layout type setting
See Also:
setLayoutType(int), NONE, BOTH, TOFIT, HORIZONTAL, VERTICAL