< prev index next >

src/java.desktop/share/classes/java/awt/image/AbstractMultiResolutionImage.java

Print this page

        

@@ -62,31 +62,85 @@
  * @since 9
  */
 public abstract class AbstractMultiResolutionImage extends java.awt.Image
         implements MultiResolutionImage {
 
+    /**
+     * Returns the width of the base image. If the width is not yet known,
+     * this method returns <code>-1</code> and the specified
+     * <code>ImageObserver</code> object is notified later.
+     * @param observer an object waiting for the image to be loaded.
+     * @return the width of this image, or <code>-1</code>
+     * if the width is not yet known.
+     */
+    
     @Override
     public int getWidth(ImageObserver observer) {
         return getBaseImage().getWidth(observer);
     }
 
+    /**
+     * Returns the height of the base image. If the height is not yet known,
+     * this method returns <code>-1</code> and the specified
+     * <code>ImageObserver</code> object is notified later.
+     * @param observer an object waiting for the image to be loaded.
+     * @return the height of this image, or <code>-1</code>
+     * if the height is not yet known.
+     */
+    
     @Override
     public int getHeight(ImageObserver observer) {
         return getBaseImage().getHeight(observer);
     }
 
+    /**
+     * Gets the object that produces the pixels for the base image.
+     * This method is called by the image filtering classes and by
+     * methods that perform image conversion and scaling.
+     * @return the {@code ImageProducer} that produces the pixels
+     * for this image.
+     */
+    
     @Override
     public ImageProducer getSource() {
         return getBaseImage().getSource();
     }
 
+     /**
+     * This method is not supported by {@code AbstractMultiResolutionImage}
+     * and always throws {@code UnsupportedOperationException}
+     *
+     * @return {@code UnsupportedOperationException} is thrown
+     * @throws UnsupportedOperationException this method is not supported
+     */
+    
     @Override
     public Graphics getGraphics() {
         throw new UnsupportedOperationException("getGraphics() not supported"
                 + " on Multi-Resolution Images");
     }
 
+    /**
+     * Gets a property of this image by name.
+     * 
+     * Individual property names are defined by the various image
+     * formats. If a property is not defined for a particular image, this
+     * method returns the {@code UndefinedProperty} object.
+     * 
+     * If the properties for this image are not yet known, this method
+     * returns {@code null}, and the {@code ImageObserver}
+     * object is notified later.
+     * 
+     * The property name {@code "comment"} should be used to store
+     * an optional comment which can be presented to the application as a
+     * description of the image, its source, or its author.
+     * @param name a property name.
+     * @param observer an object waiting for this image to be loaded.
+     * @return the value of the named property if the property name is not null.
+     * @throws      NullPointerException if the property name is null.
+     */
+    
     @Override
     public Object getProperty(String name, ImageObserver observer) {
         return getBaseImage().getProperty(name, observer);
     }
 
< prev index next >