This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
java.awt.image
interface ImageObserver
- All Known Implementing Classes:
- Component, Button, Canvas, Checkbox, Choice, Container, Label, List, Scrollbar, TextComponent, BasicSplitPaneDivider, CellRendererPane, DefaultTreeCellEditor.EditorContainer, JComponent, Panel, ScrollPane, Window, TextArea, TextField, AbstractButton, BasicInternalFrameTitlePane, Box, Box.Filler, JColorChooser, JComboBox, JFileChooser, JInternalFrame, JInternalFrame.JDesktopIcon, JLabel, JLayeredPane, JList, JMenuBar, JOptionPane, JPanel, JPopupMenu, JProgressBar, JRootPane, JScrollBar, JScrollPane, JSeparator, JSlider, JSpinner, JSplitPane, JTabbedPane, JTable, JTableHeader, JTextComponent, JToolBar, JToolTip, JTree, JViewport, Applet, BasicToolBarUI.DragWindow, Dialog, Frame, JWindow, JButton, JMenuItem, JToggleButton, MetalInternalFrameTitlePane, BasicComboBoxRenderer, DefaultListCellRenderer, DefaultTableCellRenderer, DefaultTreeCellRenderer, JDesktopPane, BasicInternalFrameTitlePane.SystemMenuBar, AbstractColorChooserPanel, JSpinner.DefaultEditor, BasicComboPopup, JScrollPane.ScrollBar, JPopupMenu.Separator, JToolBar.Separator, JEditorPane, JTextArea, JTextField, JApplet, FileDialog, JDialog, JFrame, BasicArrowButton, MetalComboBoxButton, JCheckBoxMenuItem, JMenu, JRadioButtonMenuItem, JCheckBox, JRadioButton, BasicComboBoxRenderer.UIResource, DefaultListCellRenderer.UIResource, MetalFileChooserUI.FileRenderer, MetalFileChooserUI.FilterComboBoxRenderer, DefaultTableCellRenderer.UIResource, JSpinner.DateEditor, JSpinner.ListEditor, JSpinner.NumberEditor, MetalComboBoxUI.MetalComboPopup, JTextPane, DefaultTreeCellEditor.DefaultTextField, JFormattedTextField, JPasswordField, MetalScrollButton
public interface ImageObserver
An asynchronous update interface for receiving notifications about
Image information as the Image is constructed.
Field Summary |
static int |
ABORT
This flag in the infoflags argument to imageUpdate indicates that
an image which was being tracked asynchronously was aborted before
production was complete. |
static int |
ALLBITS
This flag in the infoflags argument to imageUpdate indicates that
a static image which was previously drawn is now complete and can
be drawn again in its final form. |
static int |
ERROR
This flag in the infoflags argument to imageUpdate indicates that
an image which was being tracked asynchronously has encountered
an error. |
static int |
FRAMEBITS
This flag in the infoflags argument to imageUpdate indicates that
another complete frame of a multi-frame image which was previously
drawn is now available to be drawn again. |
static int |
HEIGHT
This flag in the infoflags argument to imageUpdate indicates that
the height of the base image is now available and can be taken
from the height argument to the imageUpdate callback method. |
static int |
PROPERTIES
This flag in the infoflags argument to imageUpdate indicates that
the properties of the image are now available. |
static int |
SOMEBITS
This flag in the infoflags argument to imageUpdate indicates that
more pixels needed for drawing a scaled variation of the image
are available. |
static int |
WIDTH
This flag in the infoflags argument to imageUpdate indicates that
the width of the base image is now available and can be taken
from the width argument to the imageUpdate callback method. |
Method Summary |
boolean |
This method is called when information about an image which was
previously requested using an asynchronous interface becomes
available.
|
ABORT
public static final int ABORT
-
This flag in the infoflags argument to imageUpdate indicates that
an image which was being tracked asynchronously was aborted before
production was complete. No more information will become available
without further action to trigger another image production sequence.
If the ERROR flag was not also set in this image update, then
accessing any of the data in the image will restart the production
again, probably from the beginning.
ALLBITS
public static final int ALLBITS
-
This flag in the infoflags argument to imageUpdate indicates that
a static image which was previously drawn is now complete and can
be drawn again in its final form. The x, y, width, and height
arguments to the imageUpdate callback method should be ignored.
ERROR
public static final int ERROR
-
This flag in the infoflags argument to imageUpdate indicates that
an image which was being tracked asynchronously has encountered
an error. No further information will become available and
drawing the image will fail.
As a convenience, the ABORT flag will be indicated at the same
time to indicate that the image production was aborted.
FRAMEBITS
public static final int FRAMEBITS
-
This flag in the infoflags argument to imageUpdate indicates that
another complete frame of a multi-frame image which was previously
drawn is now available to be drawn again. The x, y, width, and height
arguments to the imageUpdate callback method should be ignored.
HEIGHT
public static final int HEIGHT
-
This flag in the infoflags argument to imageUpdate indicates that
the height of the base image is now available and can be taken
from the height argument to the imageUpdate callback method.
PROPERTIES
public static final int PROPERTIES
-
This flag in the infoflags argument to imageUpdate indicates that
the properties of the image are now available.
SOMEBITS
public static final int SOMEBITS
-
This flag in the infoflags argument to imageUpdate indicates that
more pixels needed for drawing a scaled variation of the image
are available. The bounding box of the new pixels can be taken
from the x, y, width, and height arguments to the imageUpdate
callback method.
WIDTH
public static final int WIDTH
-
This flag in the infoflags argument to imageUpdate indicates that
the width of the base image is now available and can be taken
from the width argument to the imageUpdate callback method.
imageUpdate
public boolean imageUpdate(Image img,
int infoflags,
int x,
int y,
int width,
int height)
-
This method is called when information about an image which was
previously requested using an asynchronous interface becomes
available. Asynchronous interfaces are method calls such as
getWidth(ImageObserver) and drawImage(img, x, y, ImageObserver)
which take an ImageObserver object as an argument. Those methods
register the caller as interested either in information about
the overall image itself (in the case of getWidth(ImageObserver))
or about an output version of an image (in the case of the
drawImage(img, x, y, [w, h,] ImageObserver) call).
This method
should return true if further updates are needed or false if the
required information has been acquired. The image which was being
tracked is passed in using the img argument. Various constants
are combined to form the infoflags argument which indicates what
information about the image is now available. The interpretation
of the x, y, width, and height arguments depends on the contents
of the infoflags argument.
The infoflags
argument should be the bitwise inclusive
OR of the following flags: WIDTH
,
HEIGHT
, PROPERTIES
, SOMEBITS
,
FRAMEBITS
, ALLBITS
, ERROR
,
ABORT
.
- Parameters:
img
- the image being observed.
infoflags
- the bitwise inclusive OR of the following
flags: WIDTH
, HEIGHT
,
PROPERTIES
, SOMEBITS
,
FRAMEBITS
, ALLBITS
,
ERROR
, ABORT
.
x
- the x coordinate.
y
- the y coordinate.
width
- the width.
height
- the height.
- Returns:
false
if the infoflags indicate that the
image is completely loaded; true
otherwise.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.