com.highqsoft.fwk

Class FwkIcon

java.lang.Object

com.highqsoft.fwk.FwkIcon

All Implemented Interfaces:

FwkIconInterface, FwkInterface, java.io.Serializable, javax.swing.Icon

public class FwkIcon
extends java.lang.Object
implements FwkIconInterface

The default FwkIcon implementation.

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.17 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected FwkIconInterface	greyImage
protected java.awt.Image	image
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
FwkIcon() Creates an uninitialized image icon.
FwkIcon(byte[] imageData) Creates an ImageIcon from an array of bytes which were read from an image file containing a supported image format, such as GIF or JPEG.
FwkIcon(byte[] imageData, java.lang.String description) Creates an ImageIcon from an array of bytes which were read from an image file containing a supported image format, such as GIF or JPEG.
FwkIcon(java.awt.Image image) Creates an ImageIcon from an image object.
FwkIcon(java.awt.Image image, java.lang.String description) Creates an ImageIcon from the image.
FwkIcon(java.lang.String filename) Creates an ImageIcon from the specified file.
FwkIcon(java.lang.String filename, java.lang.String description) Creates an ImageIcon from the specified file.
FwkIcon(java.net.URL location) Creates an ImageIcon from the specified URL.
FwkIcon(java.net.URL location, java.lang.String description) Creates an ImageIcon from the specified URL.

Method Summary

Methods

Modifier and Type	Method and Description
FwkArrayInterface	getFwkMimeTypes()
int	getIconHeight() Returns the icon's height.
int	getIconWidth() Returns the icon's width.
java.awt.Image	getImage() Returns the Icon's Image
java.lang.String	getPresentationString() Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale l) Retrieves the representation string.
java.lang.String	getVersion() Return the version string of the FWK component.
void	paintIcon(java.awt.Component c, java.awt.Graphics g, int x, int y) Draw the icon at the specified location.
void	release() Release the object.
FwkIconInterface	scaleGrey() Get a grey scaled version of the icon.
java.lang.String	toString() Returns a string presentation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

image

protected java.awt.Image image

greyImage

protected FwkIconInterface greyImage

description

protected java.lang.String description

Constructor Detail

FwkIcon

public FwkIcon(java.lang.String filename,
       java.lang.String description)

Creates an ImageIcon from the specified file. The image will be preloaded by using MediaTracker to monitor the loading state of the image.

Parameters:

filename - the name of the file containing the image

description - a brief textual description of the image

See Also:

#ImageIcon(String)

FwkIcon

public FwkIcon(java.lang.String filename)

Creates an ImageIcon from the specified file. The image will be preloaded by using MediaTracker to monitor the loading state of the image. The specified String can be a file name or a file path. When specifying a path, use the Internet-standard forward-slash ("/") as a separator. For example, specify:

    new ImageIcon("images/myImage.gif")
 

(The string is converted to an URL, so the forward-slash works on all systems.)

Parameters:

filename - a String specifying a filename or path

FwkIcon

public FwkIcon(java.net.URL location,
       java.lang.String description)

Creates an ImageIcon from the specified URL. The image will be preloaded by using MediaTracker to monitor the loaded state of the image.

Parameters:

URL - the URL for the image

description - a brief textual description of the image

See Also:

#ImageIcon(String)

FwkIcon

public FwkIcon(java.net.URL location)

Creates an ImageIcon from the specified URL. The image will be preloaded by using MediaTracker to monitor the loaded state of the image.

FwkIcon

public FwkIcon(java.awt.Image image,
       java.lang.String description)

Creates an ImageIcon from the image.

Parameters:

image - the image

description - a brief textual description of the image

FwkIcon

public FwkIcon(java.awt.Image image)

Creates an ImageIcon from an image object.

FwkIcon

public FwkIcon(byte[] imageData,
       java.lang.String description)

Creates an ImageIcon from an array of bytes which were read from an image file containing a supported image format, such as GIF or JPEG. Normally this array is created by reading an image using Class.getResourceAsStream(), but the byte array may also be statically stored in a class.

Parameters:

imageData - an array of pixels in an image format supported by the AWT Toolkit, such as GIF or JPEG.

description - a brief textual description of the image

See Also:

Toolkit.createImage(java.lang.String)

FwkIcon

public FwkIcon(byte[] imageData)

Creates an ImageIcon from an array of bytes which were read from an image file containing a supported image format, such as GIF or JPEG. Normally this array is created by reading an image using Class.getResourceAsStream(), but the byte array may also be statically stored in a class.

Parameters:

an - array of pixels in an image format supported by the AWT Toolkit, such as GIF or JPEG.

See Also:

Toolkit.createImage(java.lang.String)

FwkIcon

public FwkIcon()

Creates an uninitialized image icon.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

getFwkMimeTypes

public FwkArrayInterface getFwkMimeTypes()

scaleGrey

public FwkIconInterface scaleGrey()

Get a grey scaled version of the icon.

Specified by:

scaleGrey in interface FwkIconInterface

Returns:

the greyscaled version of the icon.

toString

public java.lang.String toString()

Returns a string presentation of the object.

Overrides:

toString in class java.lang.Object

getImage

public java.awt.Image getImage()

Returns the Icon's Image

Specified by:

getImage in interface FwkIconInterface

Returns:

The image.

paintIcon

public void paintIcon(java.awt.Component c,
             java.awt.Graphics g,
             int x,
             int y)

Draw the icon at the specified location. Icon implementations may use the Component argument to get properties useful for painting, e.g. the foreground or background color.

Specified by:

paintIcon in interface javax.swing.Icon

getIconHeight

public int getIconHeight()

Returns the icon's height.

Specified by:

getIconHeight in interface javax.swing.Icon

getIconWidth

public int getIconWidth()

Returns the icon's width.

Specified by:

getIconWidth in interface javax.swing.Icon

release

public void release()

Release the object.

Specified by:

release in interface FwkInterface

getPresentationString

public java.lang.String getPresentationString(java.util.Locale l)

Retrieves the representation string. Currently it returns the name.

Parameters:

l - The Locale object or null.

Returns:

The presentation string.

getPresentationString

public java.lang.String getPresentationString()

Retrieves the representation string. Currently it returns the name.

Returns:

The presentation string.