public class

ImageView

extends View

java.lang.Object
↳	javax.swing.text.View
	↳	javax.swing.text.html.ImageView

Class Overview

View of an Image, intended to support the HTML <IMG> tag. Supports scaling via the HEIGHT and WIDTH attributes of the tag. If the image is unable to be loaded any text specified via the ALT attribute will be rendered.

While this class has been part of swing for a while now, it is public as of 1.4.

Summary

[Expand]

Inherited Constants

From class javax.swing.text.View

From interface javax.swing.SwingConstants

Public Constructors
	ImageView(Element elem) Creates a new view that represents an IMG element.

Public Methods
void	changedUpdate(DocumentEvent e, Shape a, ViewFactory f) Invoked when the Elements attributes have changed.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
String	getAltText() Returns the text to display if the image can't be loaded.
AttributeSet	getAttributes() Fetches the attributes to use when rendering.
Image	getImage() Returns the image to render.
URL	getImageURL() Return a URL for the image source, or null if it could not be determined.
Icon	getLoadingImageIcon() Returns the icon to use while in the process of loading the image.
boolean	getLoadsSynchronously() Returns true if the image should be loaded when first asked for.
Icon	getNoImageIcon() Returns the icon to use if the image couldn't be found.
float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
String	getToolTipText(float x, float y, Shape allocation) For images the tooltip text comes from text specified with the `ALT` attribute.
Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.
void	paint(Graphics g, Shape a) Paints the View.
void	setLoadsSynchronously(boolean newValue) Sets how the image is loaded.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
int	viewToModel(float x, float y, Shape a, Bias[] bias) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Protected Methods
StyleSheet	getStyleSheet() Convenience method to get the StyleSheet.
void	setPropertiesFromAttributes() Update any cached values that come from attributes.

[Expand]

Inherited Methods

From class javax.swing.text.View

void	append(View v) Appends a single child view.
View	breakView(int axis, int offset, float pos, float len) Tries to break this view on the given axis.
void	changedUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification from the document that attributes were changed in a location that this view is responsible for.
View	createFragment(int p0, int p1) Creates a view that represents a portion of the element.
void	forwardUpdate(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a, ViewFactory f) Forwards the given `DocumentEvent` to the child views that need to be notified of the change to the model.
void	forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f) Forwards the `DocumentEvent` to the give child view.
float	getAlignment(int axis) Determines the desired alignment for this view along an axis.
AttributeSet	getAttributes() Fetches the attributes to use when rendering.
int	getBreakWeight(int axis, float pos, float len) Determines how attractive a break opportunity in this view is.
Shape	getChildAllocation(int index, Shape a) Fetches the allocation for the given child view.
Container	getContainer() Fetches the container hosting the view.
Document	getDocument() Fetches the model associated with the view.
Element	getElement() Fetches the structural portion of the subject that this view is mapped to.
int	getEndOffset() Fetches the portion of the model for which this view is responsible.
Graphics	getGraphics() Fetch a `Graphics` for rendering.
float	getMaximumSpan(int axis) Determines the maximum span for this view along an axis.
float	getMinimumSpan(int axis) Determines the minimum span for this view along an axis.
int	getNextVisualPositionFrom(int pos, Position.Bias b, Shape a, int direction, Bias[] biasRet) Provides a way to determine the next visually represented model location at which one might place a caret.
View	getParent() Returns the parent of the view.
abstract float	getPreferredSpan(int axis) Determines the preferred span for this view along an axis.
int	getResizeWeight(int axis) Determines the resizability of the view along the given axis.
int	getStartOffset() Fetches the portion of the model for which this view is responsible.
String	getToolTipText(float x, float y, Shape allocation) Returns the tooltip text at the specified location.
View	getView(int n) Gets the nth child view.
int	getViewCount() Returns the number of views in this view.
ViewFactory	getViewFactory() Fetches the `ViewFactory` implementation that is feeding the view hierarchy.
int	getViewIndex(float x, float y, Shape allocation) Returns the child view index representing the given position in the view.
int	getViewIndex(int pos, Position.Bias b) Returns the child view index representing the given position in the model.
void	insert(int offs, View v) Inserts a single child view.
void	insertUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was inserted into the document in a location that this view is responsible for.
boolean	isVisible() Returns a boolean that indicates whether the view is visible or not.
Shape	modelToView(int p0, Position.Bias b0, int p1, Position.Bias b1, Shape a) Provides a mapping, for a given region, from the document model coordinate space to the view coordinate space.
Shape	modelToView(int pos, Shape a) This method is deprecated. No replacement.
abstract Shape	modelToView(int pos, Shape a, Position.Bias b) Provides a mapping, for a given character, from the document model coordinate space to the view coordinate space.
abstract void	paint(Graphics g, Shape allocation) Renders using the given rendering surface and area on that surface.
void	preferenceChanged(View child, boolean width, boolean height) Child views can call this on the parent to indicate that the preference has changed and should be reconsidered for layout.
void	remove(int i) Removes one of the children at the given position.
void	removeAll() Removes all of the children.
void	removeUpdate(DocumentEvent e, Shape a, ViewFactory f) Gives notification that something was removed from the document in a location that this view is responsible for.
void	replace(int offset, int length, View[] views) Replaces child views.
void	setParent(View parent) Establishes the parent view for this view.
void	setSize(float width, float height) Sets the size of the view.
boolean	updateChildren(DocumentEvent.ElementChange ec, DocumentEvent e, ViewFactory f) Updates the child views in response to receiving notification that the model changed, and there is change record for the element this view is responsible for.
void	updateLayout(DocumentEvent.ElementChange ec, DocumentEvent e, Shape a) Updates the layout in response to receiving notification of change from the model.
int	viewToModel(float x, float y, Shape a) This method is deprecated. No replacement.
abstract int	viewToModel(float x, float y, Shape a, Bias[] biasReturn) Provides a mapping from the view coordinate space to the logical coordinate space of the model.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public ImageView (Element elem)

Creates a new view that represents an IMG element.

Parameters

elem	the element to create a view for

Public Methods

public void changedUpdate (DocumentEvent e, Shape a, ViewFactory f)

Invoked when the Elements attributes have changed. Recreates the image.

Parameters

e	the change information from the associated document
a	the current allocation of the view
f	the factory to use to rebuild if the view has children

public float getAlignment (int axis)

Determines the desired alignment for this view along an axis. This is implemented to give the alignment to the bottom of the icon along the y axis, and the default along the x axis.

Parameters

axis	may be either X_AXIS or Y_AXIS

Returns

the desired alignment; this should be a value between 0.0 and 1.0 where 0 indicates alignment at the origin and 1.0 indicates alignment to the full span away from the origin; an alignment of 0.5 would be the center of the view

public String getAltText ()

Returns the text to display if the image can't be loaded. This is obtained from the Elements attribute set with the attribute name HTML.Attribute.ALT.

public AttributeSet getAttributes ()

Fetches the attributes to use when rendering. This is implemented to multiplex the attributes specified in the model with a StyleSheet.

public Image getImage ()

Returns the image to render.

public URL getImageURL ()

Return a URL for the image source, or null if it could not be determined.

public Icon getLoadingImageIcon ()

Returns the icon to use while in the process of loading the image.

public boolean getLoadsSynchronously ()

Returns true if the image should be loaded when first asked for.

public Icon getNoImageIcon ()

Returns the icon to use if the image couldn't be found.

public float getPreferredSpan (int axis)

Determines the preferred span for this view along an axis.

Parameters

axis	may be either X_AXIS or Y_AXIS

Returns

the span the view would like to be rendered into; typically the view is told to render into the span that is returned, although there is no guarantee; the parent may choose to resize or break the view

public String getToolTipText (float x, float y, Shape allocation)

For images the tooltip text comes from text specified with the ALT attribute. This is overriden to return getAltText.

public Shape modelToView (int pos, Shape a, Position.Bias b)

Provides a mapping from the document model coordinate space to the coordinate space of the view mapped to it.

Parameters

pos	the position to convert
a	the allocated region to render into
b	the bias toward the previous character or the next character represented by the offset, in case the position is a boundary of two views; `b` will have one of these values: `Position.Bias.Forward` `Position.Bias.Backward`

Returns

the bounding box of the given position

Throws

BadLocationException	if the given position does not represent a valid location in the associated document

public void paint (Graphics g, Shape a)

Paints the View.

Parameters

g	the rendering surface to use
a	the allocated region to render into

public void setLoadsSynchronously (boolean newValue)

Sets how the image is loaded. If newValue is true, the image we be loaded when first asked for, otherwise it will be loaded asynchronously. The default is to not load synchronously, that is to load the image asynchronously.

public void setParent (View parent)

Establishes the parent view for this view. Seize this moment to cache the AWT Container I'm in.

Parameters

parent	the new parent, or `null` if the view is being removed from a parent

public void setSize (float width, float height)

Sets the size of the view. This should cause layout of the view if it has any layout duties.

Parameters

width	the width >= 0
height	the height >= 0

public int viewToModel (float x, float y, Shape a, Bias[] bias)

Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Parameters

x	the X coordinate
y	the Y coordinate
a	the allocated region to render into

Returns

the location within the model that best represents the given point of view

Protected Methods

protected StyleSheet getStyleSheet ()

Convenience method to get the StyleSheet.

protected void setPropertiesFromAttributes ()

Update any cached values that come from attributes.

Classes

Enums

ImageView

Class Overview

See Also

Summary

Public Constructors

public ImageView (Element elem)

Parameters

Public Methods

public void changedUpdate (DocumentEvent e, Shape a, ViewFactory f)

Parameters

public float getAlignment (int axis)

Parameters

Returns

public String getAltText ()

public AttributeSet getAttributes ()

public Image getImage ()

public URL getImageURL ()

public Icon getLoadingImageIcon ()

public boolean getLoadsSynchronously ()

public Icon getNoImageIcon ()

public float getPreferredSpan (int axis)

Parameters

Returns

public String getToolTipText (float x, float y, Shape allocation)

See Also

public Shape modelToView (int pos, Shape a, Position.Bias b)

Parameters

Returns

Throws

See Also

public void paint (Graphics g, Shape a)

Parameters

See Also

public void setLoadsSynchronously (boolean newValue)

public void setParent (View parent)

Parameters

public void setSize (float width, float height)

Parameters

public int viewToModel (float x, float y, Shape a, Bias[] bias)

Parameters

Returns

See Also

Protected Methods

protected StyleSheet getStyleSheet ()

protected void setPropertiesFromAttributes ()