public class AImage extends java.lang.Object implements Image, java.io.Serializable
In other words, it is used to retrieve and store the opaque data
as polymorphic thru the Media
interface.
To encode AWT image to an instance of Image
,
use Images.encode(java.lang.String, java.awt.image.RenderedImage, float, boolean)
.
Images.encode(java.lang.String, java.awt.image.RenderedImage, float, boolean)
,
Serialized FormConstructor and Description |
---|
AImage(java.io.File file)
Constructs an image with a file.
|
AImage(java.lang.String filename)
Constructs an image with a file name.
|
AImage(java.lang.String name,
byte[] data)
Constructs an image with a byte array.
|
AImage(java.lang.String name,
java.io.InputStream is)
Constructs an image with an input stream.
|
AImage(java.net.URL url)
Constructs an image with an URL.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
getByteData()
Returns the raw data in byte array.
|
java.lang.String |
getContentType()
Returns the content type, e.g., "image/jpeg", or null if not available.
|
java.lang.String |
getFormat()
Returns the format name, e.g., "jpeg", or null if not available.
|
int |
getHeight()
Returns the height.
|
java.lang.String |
getName()
Returns the name (usually filename) of this media, or null
if not available.
|
java.io.Reader |
getReaderData()
Always throws IllegalStateException.
|
java.io.InputStream |
getStreamData()
An input stream on top of
getByteData() . |
java.lang.String |
getStringData()
Always throws IllegalStateException.
|
int |
getWidth()
Returns the width.
|
boolean |
inMemory()
Returns whether the data is cached in memory (in form of
byte[] or String).
|
boolean |
isBinary()
Returns whether the format of this content is binary or text-based.
|
boolean |
isContentDisposition()
Whether to allow Content-Disposition or not when writing the media to response header.
|
javax.swing.ImageIcon |
toImageIcon()
Converts to an image icon.
|
public AImage(java.lang.String name, byte[] data) throws java.io.IOException
java.io.IOException
public AImage(java.lang.String name, java.io.InputStream is) throws java.io.IOException
Note that this method automatically closes the input stream (since ZK 3.0.0).
java.io.IOException
public AImage(java.lang.String filename) throws java.io.IOException
java.io.IOException
public AImage(java.io.File file) throws java.io.IOException
java.io.IOException
public AImage(java.net.URL url) throws java.io.IOException
java.io.IOException
public final boolean isBinary()
Media
Media.getByteData()
or Media.getStreamData()
to retrieve its content.
If false, use Media.getStringData()
or Media.getReaderData()
to retrieve its content.isBinary
in interface Media
Media.getStringData()
,
Media.getByteData()
,
Media.getReaderData()
,
Media.getStreamData()
public final boolean inMemory()
Media
inMemory
in interface Media
Media.getStringData()
,
Media.getByteData()
,
Media.getReaderData()
,
Media.getStreamData()
public byte[] getByteData()
Media
It might not be a copy, so don't modify it directly unless you know what you are doing.
If the data is not cached in memory (Media.inMemory()
return false),
the data will be read from Media.getStreamData()
. Furthermore, it
also implies you can not invoke this method again.
getByteData
in interface Media
Media.getStringData()
public final java.lang.String getStringData()
getStringData
in interface Media
Media.getByteData()
public final java.io.InputStream getStreamData()
getByteData()
.
Though harmless, the caller doesn't need to close the returned stream.
getStreamData
in interface Media
Media.getReaderData()
public final java.io.Reader getReaderData()
getReaderData
in interface Media
Media.getStreamData()
public final java.lang.String getName()
Media
public final java.lang.String getFormat()
Media
getFormat
in interface Media
Media.getContentType()
public final java.lang.String getContentType()
Media
getContentType
in interface Media
Media.getFormat()
public final int getHeight()
public final javax.swing.ImageIcon toImageIcon()
toImageIcon
in interface Image
public boolean isContentDisposition()
Media
Default: true
isContentDisposition
in interface Media
Copyright © 2005-2018 Potix Corporation. All Rights Reserved.