Interface COM.tolstoy.imagemeister.PluginI
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface COM.tolstoy.imagemeister.PluginI

public interface PluginI
extends Object
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.

Variable Index

 o copyright
 o kDisplayName
See the getName() method.
 o kMacStyleName
See the getName() method.
 o kWinStyleName
See the getName() method.

Method Index

 o canCreateImageViewer(FileSpecifier)
Given a FileSpecifier representing a file, return a boolean value indicating whether this plugin can create an image viewer for that file.
 o canCreateInfoViewer(FileSpecifier)
Given a FileSpecifier representing a file, return a boolean value indicating whether this plugin can create an info viewer for that file.
 o createImageViewer(OwnedFrame, ImageViewerOwner, FileSpecifier, Rectangle)
Given a FileSpecifier representing a file, create an image viewer for that file.
 o createInfoViewer(OwnedFrame, InfoViewerOwner, FileSpecifier, Rectangle)
Given a FileSpecifier representing a file, create an info viewer for that file.
 o getChildren()
For a hierarchy of plugins, return an array of this plugin's child plugins.
 o getFileExtension()
Return an array of FileExtension objects, representing the non-Mac file types this plugin supports.
 o getFinderInfo()
Return an array of FinderInfo objects, representing the Mac file types this plugin supports.
 o getIconPanel()
Return an IconPanel which shows the icon representing this plugin.
 o getMIMEType()
Return an array of MIMEType objects, representing the MIME types this plugin supports.
 o getName(int)
Return the name of this plugin.
 o getParent()
For a hierarchy of plugins, return the parent of this plugin.
 o getVersionInfo()
Return version information about this plugin.

Variables

 o copyright
  public final static String copyright
 o kDisplayName
  public final static int kDisplayName
See the getName() method.
 o kMacStyleName
  public final static int kMacStyleName
See the getName() method.
 o kWinStyleName
  public final static int kWinStyleName
See the getName() method.

Methods

 o getFinderInfo
  public abstract FinderInfo[] getFinderInfo()
Return an array of FinderInfo objects, representing the Mac file types this plugin supports. May return null.
 o getFileExtension
  public abstract FileExtension[] getFileExtension()
Return an array of FileExtension objects, representing the non-Mac file types this plugin supports. May return null.
 o getMIMEType
  public abstract MIMEType[] getMIMEType()
Return an array of MIMEType objects, representing the MIME types this plugin supports. May return null.
 o canCreateImageViewer
  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.
 o canCreateInfoViewer
  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.
 o createImageViewer
  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.
Parameters:
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.
 o createInfoViewer
  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.
Parameters:
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.
 o getVersionInfo
  public abstract VersionInfo getVersionInfo()
Return version information about this plugin. May return null.
 o getName
  public abstract String getName(int which)
Return the name of this plugin.
Parameters:
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.
 o getParent
  public abstract PluginI getParent()
For a hierarchy of plugins, return the parent of this plugin. May return null.
 o getChildren
  public abstract PluginI[] getChildren()
For a hierarchy of plugins, return an array of this plugin's child plugins. May return null.
 o getIconPanel
  public abstract IconPanel getIconPanel()
Return an IconPanel which shows the icon representing this plugin. May return null.

All Packages  Class Hierarchy  This Package  Previous  Next  Index