All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.image.GraphicsImporter

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.comp.ComponentIdentifier
                   |
                   +----quicktime.std.comp.Component
                           |
                           +----quicktime.std.image.GraphicsImporter

public final class GraphicsImporter
extends Component
implements QuickTimeLib
Assists in managing still images. Allows display and manipulation of various types of image data. This is regardless of file format or compression used in the document. The QIF(QuickTime File Format, 'qtif') accepts gif, jfif, pict, photoshop, and sgi.rgb files. This class implements methods for a corresponding QuickTime ComponentInstance structure. refer to GraphicsImportComponent in QuickTime


Constructor Index

 o GraphicsImporter(DataRef)
Determines and opens the component to use for the given data reference and data type.
 o GraphicsImporter(DataRef, int)
Locates and opens a graphics importer component that can be used to draw the specified dataRef.
 o GraphicsImporter(int)
Opens the specified graphics import component,'grip', with the given subType.
 o GraphicsImporter(QTFile)
Determines and opens the graphics import component to use for the given file.
 o GraphicsImporter(QTFile, int)
Determines and opens the graphics import component to use for the given file.

Method Index

 o doesDrawAllPixels()
Determines if the GraphicsImporter will draw all the pixels that are contained in the image data that it is presenting.
 o doExportImageFileDialog(QTFile, String)
Presents a dialog box letting the user save an image in a foreign file format.
 o draw()
Draws an image.
 o exportImageFile(int, int, QTFile, int)
Saves an image in a foreign file format.
 o getAliasedDataReference()
Determines the aliased data reference.
 o getAliasedDataType()
Determines the aliased data type.
 o getAsPicture()
Creates a new Pict containing the image currently in use by this import component.
 o getBoundsRect()
Determines the bounding rectangle for drawing.
 o getClip()
Determines the current clipping region.
 o getDataFile()
Determines the file that the graphics resides in.
 o getDataHandle()
Determines the data reference that the graphics resides in.
 o getDataOffset()
Determines the data offset.
 o getDataReferenceType()
Determines the type of the data reference that the graphics resides in.
 o getDataSize()
Determines the data size.
 o getExportImageTypeList()
Returns information about available export formats.
 o getExportSettingsAsAtomContainer()
Returns the Export settings as an Atom Container.
 o getGraphicsMode()
Determines the graphics mode for an image.
 o getGWorld()
Call this method to obtain the QDGraphics of the object.
 o getImageDescription()
Determines the image description information.
 o getMatrix()
Determines the matrix to be used for drawing.
 o getMetaData(GraphicsImporter)
Gets metadata from an image file and adds it to a user data structure.
 o getMIMETypeList()
Returns a list of MIME types supported by the graphics import component.
 o getNaturalBounds()
Determines the bounding rectangle of an image.
 o getQuality()
Determines the image quality value.
 o getSourceRect()
Determines the current source rectangle for an image.
 o readData(EncodedImage, int, int)
Reads image data.
 o saveAsPicture(QTFile, int)
Creates a QuickDraw picture file.
 o saveAsQuickTimeImageFile(QTFile, int)
Creates a QuickDraw image file.
 o setBoundsRect(QDRect)
Defines the rectangle in which to draw an image.
 o setClip(Region)
Defines the clipping region for drawing.
 o setDataFile(QTFile)
Specifies the file that the graphics resides in.
 o setDataHandle(QTHandleRef)
Specifies the data handle that the graphics resides in.
 o setDataReference(DataRef)
Specifies the data reference that the graphics resides in.
 o setExportSettingsFromAtomContainer(AtomContainer)
Export settings from a QuickTime atom container.
 o setGraphicsMode(GraphicsMode)
Sets the graphics mode and color for an image.
 o setGWorld(QDGraphics, GDevice)
Call this method to give the client the QDGraphics object it should use to do its drawing.
 o setMatrix(Matrix)
Defines the matrix to use for drawing.
 o setQuality(int)
Sets the image quality value.
 o setSourceRect(QDRect)
Sets the source rectangle to use for an image.
 o validate()
Determines if the current graphics importer data reference contains valid image data.

Constructors

 o GraphicsImporter
 public GraphicsImporter(int subType) throws QTException
Opens the specified graphics import component,'grip', with the given subType.

QuickTime::OpenADefaultComponent

Parameters:
subType - The graphics import component sub type
 o GraphicsImporter
 public GraphicsImporter(QTFile file) throws QTException
Determines and opens the graphics import component to use for the given file.

QuickTime::GetGraphicsImporterForFile QuickTime::GetGraphicsImporterForFile

Parameters:
file - Specifies the source file.
 o GraphicsImporter
 public GraphicsImporter(QTFile file,
                         int flags) throws QTException
Determines and opens the graphics import component to use for the given file.

QuickTime::GetGraphicsImporterForFile QuickTime::GetGraphicsImporterForFile

Parameters:
file - Specifies the source file.
flags - options passed in when opening the component
 o GraphicsImporter
 public GraphicsImporter(DataRef dataRef) throws QTException
Determines and opens the component to use for the given data reference and data type.

QuickTime::GetGraphicsImporterForDataRef QuickTime::GetGraphicsImporterForDataRef

Parameters:
dataRef - Specifies the data reference.
 o GraphicsImporter
 public GraphicsImporter(DataRef dataRef,
                         int flags) throws QTException
Locates and opens a graphics importer component that can be used to draw the specified dataRef.

QuickTime::GetGraphicsImporterForDataRefWithFlags

Parameters:
dataRef - Specifies the data reference.
flags - options passed in when opening the component

Methods

 o setDataReference
 public final void setDataReference(DataRef dataRef) throws StdQTException
Specifies the data reference that the graphics resides in.

QuickTime::GraphicsImportSetDataReference

Parameters:
dataRef - Specifies the handle to a QuickTime data reference.
 o getDataReferenceType
 public final int getDataReferenceType() throws StdQTException
Determines the type of the data reference that the graphics resides in.

QuickTime::GraphicsImportGetDataReference

Returns:
The data reference type.
 o setDataFile
 public final void setDataFile(QTFile fileIn) throws QTException
Specifies the file that the graphics resides in.

QuickTime::GraphicsImportSetDataFile

Parameters:
fileIn - Specifies the source file containing the graphics data.
 o getDataFile
 public final QTFile getDataFile() throws QTException
Determines the file that the graphics resides in.

QuickTime::GraphicsImportGetDataFile

Returns:
The file that contains the graphics data.
 o setDataHandle
 public final void setDataHandle(QTHandleRef dataRef) throws StdQTException
Specifies the data handle that the graphics resides in.

QuickTime::GraphicsImportSetDataHandle

Parameters:
dataRef - Specifies the handle to a QuickTime data reference.
 o getDataHandle
 public final QTHandle getDataHandle() throws QTException
Determines the data reference that the graphics resides in.

QuickTime::GraphicsImportGetDataHandle

Returns:
The handle to a QuickTime data reference.
 o getImageDescription
 public final ImageDescription getImageDescription() throws StdQTException
Determines the image description information.

QuickTime::GraphicsImportGetImageDescription

 o getDataOffset
 public final int getDataOffset() throws StdQTException
Determines the data offset.

QuickTime::GraphicsImportGetDataOffsetAndSize

Returns:
The offset for the data.
 o getDataSize
 public final int getDataSize() throws StdQTException
Determines the data size.

QuickTime::GraphicsImportGetDataOffsetAndSize

Returns:
The size of the data.
 o readData
 public final void readData(EncodedImage data,
                            int dataOffset,
                            int dataSize) throws StdQTException
Reads image data. The pointer must be at least offset + size big.

QuickTime::GraphicsImportReadData

Parameters:
data - The EncodedImage that the data is read into.
dataOffset - Specifies the offset within the pointer where the data is placed. This offset is in bytes.
dataSize - Specifies the size of the data to be read.
 o setClip
 public final void setClip(Region clipRgn) throws StdQTException
Defines the clipping region for drawing.

QuickTime::GraphicsImportSetClip

Parameters:
clipRgn - Specifies clipping region.
 o getClip
 public final Region getClip() throws QTException
Determines the current clipping region.

QuickTime::GraphicsImportGetClip

Returns:
The current clip region or null, if not possible
 o setSourceRect
 public final void setSourceRect(QDRect srcRect) throws StdQTException
Sets the source rectangle to use for an image.

QuickTime::GraphicsImportSetSourceRect

Parameters:
sourceRect - Specifies source rectangle
 o getSourceRect
 public final QDRect getSourceRect() throws StdQTException
Determines the current source rectangle for an image.

QuickTime::GraphicsImportGetSourceRect

Returns:
The current source rectangle for an image.
 o getNaturalBounds
 public final QDRect getNaturalBounds() throws StdQTException
Determines the bounding rectangle of an image.

QuickTime::GraphicsImportGetNaturalBounds

Returns:
The size of the bounding rectangle for an image.
 o draw
 public final void draw() throws StdQTException
Draws an image.

QuickTime::GraphicsImportDraw

 o setMatrix
 public final void setMatrix(Matrix matrix) throws StdQTException
Defines the matrix to use for drawing.

QuickTime::GraphicsImportSetMatrix

Parameters:
matrix - Specifies the drawing matrix.
 o getMatrix
 public final Matrix getMatrix() throws StdQTException
Determines the matrix to be used for drawing.

QuickTime::GraphicsImportGetMatrix

Returns:
The matrix specification to use for drawing.
 o setBoundsRect
 public final void setBoundsRect(QDRect bounds) throws StdQTException
Defines the rectangle in which to draw an image.

QuickTime::GraphicsImportSetBoundsRect

Parameters:
bounds - Specifies the bounding rectangle.
 o getBoundsRect
 public final QDRect getBoundsRect() throws StdQTException
Determines the bounding rectangle for drawing.

QuickTime::GraphicsImportGetBoundsRect

Returns:
The bounding rectangle.
 o saveAsPicture
 public final void saveAsPicture(QTFile file,
                                 int scriptTag) throws QTException
Creates a QuickDraw picture file.

QuickTime::GraphicsImportSaveAsPicture

Parameters:
file - The destination output file of the compressed image
scriptTag - Specifies the depth at which the image is to be compressed.
 o saveAsQuickTimeImageFile
 public final void saveAsQuickTimeImageFile(QTFile file,
                                            int scriptTag) throws QTException
Creates a QuickDraw image file.

QuickTime::GraphicsImportSaveAsQuickTimeImageFile

Parameters:
fss - Specifies the destination file.
scriptTag - Specifies
 o setGraphicsMode
 public final void setGraphicsMode(GraphicsMode graphicsMode) throws StdQTException
Sets the graphics mode and color for an image.

QuickTime::GraphicsImportSetGraphicsMode

Parameters:
graphicsMode - Specifies the graphics transfer mode.
 o getGraphicsMode
 public final GraphicsMode getGraphicsMode() throws StdQTException
Determines the graphics mode for an image.

QuickTime::GraphicsImportGetGraphicsMode

Returns:
The graphics transfer mode.
 o setQuality
 public final void setQuality(int quality) throws StdQTException
Sets the image quality value.

QuickTime::GraphicsImportSetQuality

Parameters:
quality - Specifies a quality CodecQ value
 o getQuality
 public final int getQuality() throws StdQTException
Determines the image quality value.

QuickTime::GraphicsImportGetQuality

Returns:
The image quality value.
 o getAliasedDataReference
 public final QTHandle getAliasedDataReference() throws QTException
Determines the aliased data reference.

QuickTime::GraphicsImportGetAliasedDataReference

Returns:
The handle to the aliased data reference
 o getAliasedDataType
 public final int getAliasedDataType() throws StdQTException
Determines the aliased data type.

QuickTime::GraphicsImportGetAliasedDataReference

Returns:
The aliased data type
 o setGWorld
 public final void setGWorld(QDGraphics port,
                             GDevice gdh) throws StdQTException
Call this method to give the client the QDGraphics object it should use to do its drawing.

QuickTime::GraphicsImportSetGWorld

Parameters:
port - a QDGraphics object or null to use current port
gdh - a GDevice object or null to use current device
 o getGWorld
 public final QDGraphics getGWorld() throws StdQTException
Call this method to obtain the QDGraphics of the object.

QuickTime::GraphicsImportGetGWorld

Returns:
The current destination graphics port
 o validate
 public final boolean validate() throws StdQTException
Determines if the current graphics importer data reference contains valid image data. Not all graphics importers implement this method.

QuickTime::GraphicsImportValidate

Returns:
True if a valid operation, false otherwise.
 o doesDrawAllPixels
 public final int doesDrawAllPixels() throws StdQTException
Determines if the GraphicsImporter will draw all the pixels that are contained in the image data that it is presenting. Some image formats (for example GIF) allow a color to be set as invisible or transparent.

QuickTime::GraphicsImportDoesDrawAllPixels

Returns:
a value that indicates if this instance of the importer will draw all pixels
 o getAsPicture
 public Pict getAsPicture() throws QTException
Creates a new Pict containing the image currently in use by this import component.

QuickTime::GraphicsImportGetAsPicture

Returns:
a pict
 o getMetaData
 public UserData getMetaData(GraphicsImporter gi) throws QTException
Gets metadata from an image file and adds it to a user data structure.

QuickTime::GraphicsImportGetMetaData

Returns:
a UserData structure
 o getMIMETypeList
 public AtomContainer getMIMETypeList() throws StdQTException
Returns a list of MIME types supported by the graphics import component.

QuickTime::GraphicsImportGetMIMETypeList

Returns:
a QT atom container that contains a list of MIME types supported by the graphics import component.
 o exportImageFile
 public void exportImageFile(int fileType,
                             int fileCreator,
                             QTFile theFile,
                             int scriptTag) throws QTException
Saves an image in a foreign file format.

QuickTime::GraphicsImportExportImageFile

Parameters:
fileType - the file type
fileCreator - the fie creator
theFile - the output file to write to.
 o getExportImageTypeList
 public final AtomContainer getExportImageTypeList() throws StdQTException
Returns information about available export formats.

QuickTime::GraphicsImportGetExportImageTypeList

Returns:
a QT atom container that contains a list of available export formats. supported by the graphics import component.
 o getExportSettingsAsAtomContainer
 public final AtomContainer getExportSettingsAsAtomContainer() throws StdQTException
Returns the Export settings as an Atom Container.

QuickTime::GraphicsImportGetExportSettingsAsAtomContainer

Returns:
a QT atom container that contains Export settings.
 o setExportSettingsFromAtomContainer
 public final void setExportSettingsFromAtomContainer(AtomContainer qtAtomContainer) throws StdQTException
Export settings from a QuickTime atom container. These settings configure how images will be saved by the GraphicsImportExportImageFile function..

QuickTime::GraphicsImportSetExportSettingsFromAtomContainer

Parameters:
qtAtomContainer - the atomcontainer with the export settings.
 o doExportImageFileDialog
 public final GraphicsImporterInfo doExportImageFileDialog(QTFile inDefaultSpec,
                                                           String prompt) throws QTException
Presents a dialog box letting the user save an image in a foreign file format.

QuickTime::GraphicsImportDoExportImageFileDialog

Parameters:
inDefaultSpec - suggests the default name for the file. If you do not want to suggest a default name, pass null.
prompt - A prompt that appears in the standard put dialog box; it may be nil, in which case a default string is used.

All Packages  Class Hierarchy  This Package  Previous  Next  Index