ImageRegionSelector Bean API

API Documentation

API documentation is produced by running the source code through the javadoc program supplied with Sun's JDK. The standard html pages produced are:

ImageRegionSelector 1.0 is contained within a single package, com.ibm.eou.swingimageregionselector

This package contains the ImageRegionSelector bean.

This package also contains the following components and classes:

Properties Reference

The following table lists the properties of the ImageRegionSelector bean. You can set any of these properties using a visual builder or by calling an API, apart from SelectedValue which is a read-only property.

Property Description API
Display Image The image the user sees and selects regions from. All the properties that specify image names as Strings require the file name including the path. If the file is within the local filespace then simply give the full path with the file name (eg. C:/Java/Images/DisplayImage.gif). The image files can also be read from a jar file - which requires path and file name within that jar (eg /com/ibm/eou/swingimageregionselector/DisplayImage.gif) setDisplayImage
Color Map Image The image used for hit-correlation to map mouse positions to regions setColorMapImage
Cutaway Image The image shown through a cutaway window for the region when cutaway emphasis is selected and is only needed for this emphasis style setCutawayImage
Selection Emphasis Style Specifies the emphasis style applied to a region when it is selected and can be one of the following: No emphasis, Lighten Emphasis, Darken Emphasis, Negative Emphasis, Cutaway Emphasis

Values:

  • ImageRegionSelector.NONE (0)
  • ImageRegionSelector.LIGHTEN (1)
  • ImageRegionSelector.DARKEN (2)
  • ImageRegionSelector.NEGATIVE (3)
  • ImageRegionSelector.CUTAWAY (4)
setSelectionEmphasisStyle
Rollover Emphasis Style Specifies the emphasis style applied to a region when the mouse is moved inside the region. This takes the same values as the Selection Emphasis Style property above setRolloverEmphasisStyle
Selected Index Sets the regions with the specified index to be selected and emphasises this region if a selection emphasis style is specified setSelectedIndex
Tooltips Strings displayed as tooltip text when the mouse hovers over a region. The order of these Strings corresponds to the indices of the regions in the color map image. setTooltips
Region Names Strings which represent labels given to each region. This allows the selected region to be specified as a string which is possible with JList components. The order of these Strings corresponds to the indices of the regions in the color map image. setRegionNames
Selected Value This property is the region name which corresponds to the selected index property. This allows the selected region to be returned as an Object rather than an integer. This is a read-only property.