Main Page
Cookbook/Overview ImageMeister the jcprops file Licensing Binary Installation & Configuration [ Win · Mac · Nix · OSX ] 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 · OSX ] Distribution Issues |
All Packages This Package Class Hierarchy Class Search Index
Summary |
public interface PluginI { // Fields 4 public static final String copyright; public static final int kDisplayName; public static final int kMacStyleName; public static final int kWinStyleName; // Methods 12 public abstract boolean canCreateImageViewer(FileSpecifier); public abstract boolean canCreateInfoViewer(FileSpecifier); public abstract ImageViewerI createImageViewer(OwnedFrame, ImageViewerOwner, FileSpecifier, Rectangle); public abstract InfoViewerI createInfoViewer(OwnedFrame, InfoViewerOwner, FileSpecifier, Rectangle); public abstract PluginI[] getChildren(); public abstract FileExtension[] getFileExtension(); public abstract FinderInfo[] getFinderInfo(); public abstract IconPanel getIconPanel(); public abstract MIMEType[] getMIMEType(); public abstract String getName(int); public abstract PluginI getParent(); public abstract VersionInfo getVersionInfo(); }
This interface is used to represent plugins. Objects which implement this interface are used to create instances of image and info viewers, indicate which file types this plugin supports, and return other information on the plugin. Copyright (c) 1998-2002 Samizdat Productions. All Rights Reserved. ImageMeister is a Trademark of Samizdat Productions.
Cross Reference |
Fields |
· copyright | Summary | Top |
public static final String copyright
· kDisplayName | Summary | Top |
public static final int kDisplayName
See the getName() method.
· kMacStyleName | Summary | Top |
public static final int kMacStyleName
See the getName() method.
· kWinStyleName | Summary | Top |
public static final int kWinStyleName
See the getName() method.
Methods |
· getFinderInfo | Summary | Top |
public abstract FinderInfo[] getFinderInfo()
Return an array of FinderInfo objects, representing the Mac file types this plugin supports. May return null.
· getFileExtension | Summary | Top |
public abstract FileExtension[] getFileExtension()
Return an array of FileExtension objects, representing the non-Mac file types this plugin supports. May return null.
· getMIMEType | Summary | Top |
public abstract MIMEType[] getMIMEType()
Return an array of MIMEType objects, representing the MIME types this plugin supports. May return null.
· canCreateImageViewer | Summary | Top |
public abstract boolean canCreateImageViewer(FileSpecifier spec)
Given a FileSpecifier representing a file, return a boolean value indicating whether this plugin can create an image viewer for that file. Note that any object contained by the FileSpecifier may be null, with the exception that not both the DiskObject and the File contained by the FileSpecifier will be null.
· canCreateInfoViewer | Summary | Top |
public abstract boolean canCreateInfoViewer(FileSpecifier spec)
Given a FileSpecifier representing a file, return a boolean value indicating whether this plugin can create an info viewer for that file. Note that any object contained by the FileSpecifier may be null, with the exception that not both the DiskObject and the File contained by the FileSpecifier will be null.
· createImageViewer | Summary | Top |
public abstract ImageViewerI createImageViewer(OwnedFrame frame, ImageViewerOwner onr, FileSpecifier spec, Rectangle rect)
Given a FileSpecifier representing a file, create an image viewer for that file. This method may return null if the image viewer could not be created. Note that any object contained by the FileSpecifier may be null, with the exception that not both the DiskObject and the File contained by the FileSpecifier will be null.
Parameter Description frame if this is not null, show the file in this frame. Otherwise, create a new OwnedFrame, and show the file in the new frame. onr the object which owns this viewer spec specifies the file to be shown rect the suggested location and dimensions of the viewer. If the frame argument is null, the WindowManager should be used to correctly place the new frame. Otherwise, the current location and dimensions of the supplied frame should be used.
· createInfoViewer | Summary | Top |
public abstract InfoViewerI createInfoViewer(OwnedFrame frame, InfoViewerOwner onr, FileSpecifier spec, Rectangle rect)
Given a FileSpecifier representing a file, create an info viewer for that file. This method may return null if the info viewer could not be created. Note that any object contained by the FileSpecifier may be null, with the exception that not both the DiskObject and the File contained by the FileSpecifier will be null.
Parameter Description frame if this is not null, show the file in this frame. Otherwise, create a new OwnedFrame, and show the file in the new frame. onr the object which owns this viewer spec specifies the file to be shown rect the suggested location and dimensions of the viewer. If the frame argument is null, the WindowManager should be used to correctly place the new frame. Otherwise, the current location and dimensions of the supplied frame should be used.
· getVersionInfo | Summary | Top |
public abstract VersionInfo getVersionInfo()
Return version information about this plugin. May return null.
· getName | Summary | Top |
public abstract String getName(int which)
Return the name of this plugin.
Parameter Description which if this is 'kDisplayName', return the generic name of this plugin. If this is 'kMacStyleName', return the Mac-style name, and if this is 'kWinStyleName', return the Windows-style name. If 'which' is not one of these values, return null.
· getParent | Summary | Top |
public abstract PluginI getParent()
For a hierarchy of plugins, return the parent of this plugin. May return null.
· getChildren | Summary | Top |
public abstract PluginI[] getChildren()
For a hierarchy of plugins, return an array of this plugin's child plugins. May return null.
· getIconPanel | Summary | Top |
public abstract IconPanel getIconPanel()
Return an IconPanel which shows the icon representing this plugin. May return null.
All Packages This Package Class Hierarchy Class Search IndexFreshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7