Class ImageView

java.lang.Object

javax.swing.text.View

javax.swing.text.html.ImageView

All Implemented Interfaces:: SwingConstants

public class ImageView extends View

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.

Since:

1.4

See Also:

Field Summary

Fields declared in class View

BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Modifier and Type	Field	Description
`static final int`	`BadBreakWeight`	The weight to indicate a view is a bad break opportunity for the purpose of formatting.
`static final int`	`ExcellentBreakWeight`	The weight to indicate a view supports breaking, and this represents a very attractive place to break.
`static final int`	`ForcedBreakWeight`	The weight to indicate a view supports breaking, and must be broken to be represented properly when placed in a view that formats its children by breaking them.
`static final int`	`GoodBreakWeight`	The weight to indicate a view supports breaking, but better opportunities probably exist.
`static final int`	`X_AXIS`	Axis for format/break operations.
`static final int`	`Y_AXIS`	Axis for format/break operations.

Fields declared in interface SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Modifier and Type	Field	Description
`static final int`	`BOTTOM`	Box-orientation constant used to specify the bottom of a box.
`static final int`	`CENTER`	The central position in an area.
`static final int`	`EAST`	Compass-direction east (right).
`static final int`	`HORIZONTAL`	Horizontal orientation.
`static final int`	`LEADING`	Identifies the leading edge of text for use with left-to-right and right-to-left languages.
`static final int`	`LEFT`	Box-orientation constant used to specify the left side of a box.
`static final int`	`NEXT`	Identifies the next direction in a sequence.
`static final int`	`NORTH`	Compass-direction North (up).
`static final int`	`NORTH_EAST`	Compass-direction north-east (upper right).
`static final int`	`NORTH_WEST`	Compass-direction north west (upper left).
`static final int`	`PREVIOUS`	Identifies the previous direction in a sequence.
`static final int`	`RIGHT`	Box-orientation constant used to specify the right side of a box.
`static final int`	`SOUTH`	Compass-direction south (down).
`static final int`	`SOUTH_EAST`	Compass-direction south-east (lower right).
`static final int`	`SOUTH_WEST`	Compass-direction south-west (lower left).
`static final int`	`TOP`	Box-orientation constant used to specify the top of a box.
`static final int`	`TRAILING`	Identifies the trailing edge of text for use with left-to-right and right-to-left languages.
`static final int`	`VERTICAL`	Vertical orientation.
`static final int`	`WEST`	Compass-direction west (left).

Constructor Summary

Constructor	Description
`ImageView(Element elem)`	Creates a new view that represents an IMG element.

Method Summary

Modifier and Type	Method	Description
`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 cannot 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 could not be found.
`float`	`getPreferredSpan(int axis)`	Determines the preferred span for this view along an axis.
`protected StyleSheet`	`getStyleSheet()`	Convenient method to get the StyleSheet.
`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.
`protected void`	`setPropertiesFromAttributes()`	Update any cached values that come from attributes.
`void`	`setSize(float width, float height)`	Sets the size of the view.
`int`	`viewToModel(float x, float y, Shape a, Position.Bias[] bias)`	Provides a mapping from the view coordinate space to the logical coordinate space of the model.

Methods declared in class View

append, breakView, createFragment, forwardUpdate, forwardUpdateToView, getBreakWeight, getChildAllocation, getContainer, getDocument, getElement, getEndOffset, getGraphics, getMaximumSpan, getMinimumSpan, getNextVisualPositionFrom, getParent, getResizeWeight, getStartOffset, getView, getViewCount, getViewFactory, getViewIndex, getViewIndex, insert, insertUpdate, isVisible, modelToView, modelToView, preferenceChanged, remove, removeAll, removeUpdate, replace, updateChildren, updateLayout, viewToModel

Modifier and Type	Method	Description
`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.
`View`	`createFragment(int p0, int p1)`	Creates a view that represents a portion of the element.
`protected 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.
`protected void`	`forwardUpdateToView(View v, DocumentEvent e, Shape a, ViewFactory f)`	Forwards the `DocumentEvent` to the give child view.
`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, Position.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.
`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.
`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 pos, Shape a)`	Deprecated.
`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.
`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.
`protected 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.
`protected 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)`	Deprecated.

Methods declared in class Object

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

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this 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 it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

ImageView

public ImageView(Element elem)

Creates a new view that represents an IMG element.

Parameters:: elem - the element to create a view for

Method Details

getAltText

public String getAltText()

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

Returns:: the test to display if the image cannot be loaded.

getImageURL

public URL getImageURL()

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

Returns:: the URL for the image source, or null if it could not be determined.

getNoImageIcon

public Icon getNoImageIcon()

Returns the icon to use if the image could not be found.

Returns:: the icon to use if the image could not be found.

getLoadingImageIcon

public Icon getLoadingImageIcon()

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

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

getImage

public Image getImage()

Returns the image to render.

Returns:: the image to render.

setLoadsSynchronously

public void setLoadsSynchronously(boolean newValue)

Sets how the image is loaded. If newValue is true, the image will 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.

Parameters:: newValue - if true the image will be loaded when first asked for, otherwise it will be asynchronously.

getLoadsSynchronously

public boolean getLoadsSynchronously()

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

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

getStyleSheet

protected StyleSheet getStyleSheet()

Convenient method to get the StyleSheet.

Returns:: the StyleSheet

getAttributes

public AttributeSet getAttributes()

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

Overrides:: getAttributes in class View
Returns:: the attributes to use when rendering

getToolTipText

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

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

Overrides:

getToolTipText in class View

Parameters:

x - the x coordinate

y - the y coordinate

allocation - current allocation of the View.

Returns:

the tooltip text at the specified location

See Also:

setPropertiesFromAttributes

protected void setPropertiesFromAttributes()

Update any cached values that come from attributes.

setParent

public void setParent(View parent)

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

Overrides:: setParent in class View
Parameters:: parent - the new parent, or null if the view is being removed from a parent

changedUpdate

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

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

Overrides:

changedUpdate in class View

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

See Also:

paint

public void paint(Graphics g, Shape a)

Paints the View.

Specified by:

paint in class View

Parameters:

g - the rendering surface to use

a - the allocated region to render into

See Also:

getPreferredSpan

public float getPreferredSpan(int axis)

Determines the preferred span for this view along an axis.

Specified by:: getPreferredSpan in class View
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

getAlignment

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.

Overrides:: getAlignment in class View
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

modelToView

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

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

Specified by:

modelToView in class View

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

See Also:

viewToModel

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

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

Specified by:

viewToModel in class View

Parameters:

x - the X coordinate

y - the Y coordinate

a - the allocated region to render into

bias - the returned bias

Returns:

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

See Also:

setSize

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.

Overrides:: setSize in class View
Parameters:: width - the width >= 0; height - the height >= 0

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.