Main Page Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix ] Changes Public API Source Code Main Page Java [ Common · Win · Mac · Nix ] Native Code [ Common · Win · Mac · Nix ] Manifest Native Code Overviews [ Common · Win · Mac · Nix · Strings ] Macros [ General · Native Macros ] Walkthroughs [ Java only · Java and native ] Building [ Win · Mac · Nix ] Distribution Issues

    All Packages  This Package  Class Hierarchy  Class Search  Index

Interface com.jconfig.IconBundle

Summary

    public interface  IconBundle
    {
              // Fields 22
         public static final int ICON_ALIGN_BOTTOM;
         public static final int ICON_ALIGN_HCENTER;
         public static final int ICON_ALIGN_LEFT;
         public static final int ICON_ALIGN_NONE;
         public static final int ICON_ALIGN_RIGHT;
         public static final int ICON_ALIGN_TOP;
         public static final int ICON_ALIGN_VCENTER;
         public static final int ICON_CHANGE_DISABLED;
         public static final int ICON_CHANGE_LABEL1;
         public static final int ICON_CHANGE_LABEL2;
         public static final int ICON_CHANGE_LABEL3;
         public static final int ICON_CHANGE_LABEL4;
         public static final int ICON_CHANGE_LABEL5;
         public static final int ICON_CHANGE_LABEL6;
         public static final int ICON_CHANGE_LABEL7;
         public static final int ICON_CHANGE_NONE;
         public static final int ICON_CHANGE_OFFLINE;
         public static final int ICON_CHANGE_OPEN;
         public static final int ICON_CHANGE_SELECTED;
         public static final int ICON_LARGE;
         public static final int ICON_SMALL;
         public static final String copyrightString;

              // Methods 3
         public abstract int getIcon(int, int, int, int[]);
         public abstract int getIconHeight(int);
         public abstract int getIconWidth(int);
    }

Represents a pair of related icons, a small icon and a large icon.

Author:
  Copyright (c) 1997,1998,1999,2000 Samizdat Productions. All Rights Reserved.

Cross Reference

Returned By:
  AppFile.getIconBundle(), DiskObject.getIconBundle(), AppFileMRJ.getIconBundle(), DiskFileMRJ.getIconBundle(), DiskVolumeMRJ.getIconBundle(), IconBundleFactoryMRJ.createFromFTAC(), IconBundleFactoryMRJ.createFromFile(), IconBundleFactoryMRJ.createFromVolume(), AppFileNix.getIconBundle(), DiskFileNix.getIconBundle(), DiskVolumeNix.getIconBundle(), AppFileMSVM.getIconBundle(), DiskFileMSVM.getIconBundle(), DiskVolumeMSVM.getIconBundle()

Implemented By:
  IconBundleMRJ, IconBundleNix, IconBundleMSVM

Fields

### · copyrightString | Summary | Top

       public static final String copyrightString

### · ICON_LARGE | Summary | Top

       public static final int ICON_LARGE

> A large 32-bit color icon.

### · ICON_SMALL | Summary | Top

       public static final int ICON_SMALL

> A small 32-bit color icon.

### · ICON_ALIGN_NONE | Summary | Top

       public static final int ICON_ALIGN_NONE

> An alignment value.

### · ICON_ALIGN_VCENTER | Summary | Top

       public static final int ICON_ALIGN_VCENTER

> An alignment value.

### · ICON_ALIGN_TOP | Summary | Top

       public static final int ICON_ALIGN_TOP

> An alignment value.

### · ICON_ALIGN_BOTTOM | Summary | Top

       public static final int ICON_ALIGN_BOTTOM

> An alignment value.

### · ICON_ALIGN_HCENTER | Summary | Top

       public static final int ICON_ALIGN_HCENTER

> An alignment value.

### · ICON_ALIGN_LEFT | Summary | Top

       public static final int ICON_ALIGN_LEFT

> An alignment value.

### · ICON_ALIGN_RIGHT | Summary | Top

       public static final int ICON_ALIGN_RIGHT

> An alignment value.

### · ICON_CHANGE_NONE | Summary | Top

       public static final int ICON_CHANGE_NONE

> A transform value.

### · ICON_CHANGE_DISABLED | Summary | Top

       public static final int ICON_CHANGE_DISABLED

> A transform value.

### · ICON_CHANGE_OFFLINE | Summary | Top

       public static final int ICON_CHANGE_OFFLINE

> A transform value.

### · ICON_CHANGE_OPEN | Summary | Top

       public static final int ICON_CHANGE_OPEN

> A transform value.

### · ICON_CHANGE_LABEL1 | Summary | Top

       public static final int ICON_CHANGE_LABEL1

> A transform value.

### · ICON_CHANGE_LABEL2 | Summary | Top

       public static final int ICON_CHANGE_LABEL2

> A transform value.

### · ICON_CHANGE_LABEL3 | Summary | Top

       public static final int ICON_CHANGE_LABEL3

> A transform value.

### · ICON_CHANGE_LABEL4 | Summary | Top

       public static final int ICON_CHANGE_LABEL4

> A transform value.

### · ICON_CHANGE_LABEL5 | Summary | Top

       public static final int ICON_CHANGE_LABEL5

> A transform value.

### · ICON_CHANGE_LABEL6 | Summary | Top

       public static final int ICON_CHANGE_LABEL6

> A transform value.

### · ICON_CHANGE_LABEL7 | Summary | Top

       public static final int ICON_CHANGE_LABEL7

> A transform value.

### · ICON_CHANGE_SELECTED | Summary | Top

       public static final int ICON_CHANGE_SELECTED

> A transform value.

Methods

### · getIcon | Summary | Top

       public abstract int getIcon(int whichIcon,
                                   int xform,
                                   int align,
                                   int[] pData)

> Puts the RGB pixel data for the indicated icon into the given array. If no error occurs, return 0; otherwise, a non-zero error code is returned.

> Parameter | Description
> whichIcon | one of the previously listed icon styles.
> xform | one of the transform values listed above
> align | one of the alignment values listed above
> pData | an array which will be filled with the appropriate values. This array must be exactly equal in size to the width times the height of the desired icon.

### · getIconWidth | Summary | Top

       public abstract int getIconWidth(int whichIcon)

> Returns the width of the indicated icon.

> Parameter | Description
> whichIcon | one of the previously listed icon styles.

### · getIconHeight | Summary | Top

       public abstract int getIconHeight(int whichIcon)

> Returns the height of the indicated icon.

> Parameter | Description
> whichIcon | one of the previously listed icon styles.

    All Packages  This Package  Class Hierarchy  Class Search  Index

Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7