Liking cljdoc? Tell your friends :D

javax.swing.text.html.ImageView

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.

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.
raw docstring

->image-viewclj

(->image-view elem)

Constructor.

Creates a new view that represents an IMG element.

elem - the element to create a view for - javax.swing.text.Element

Constructor.

Creates a new view that represents an IMG element.

elem - the element to create a view for - `javax.swing.text.Element`
raw docstring

changed-updateclj

(changed-update this e a f)

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

e - the change information from the associated document - javax.swing.event.DocumentEvent a - the current allocation of the view - java.awt.Shape f - the factory to use to rebuild if the view has children - javax.swing.text.ViewFactory

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

e - the change information from the associated document - `javax.swing.event.DocumentEvent`
a - the current allocation of the view - `java.awt.Shape`
f - the factory to use to rebuild if the view has children - `javax.swing.text.ViewFactory`
raw docstring

get-alignmentclj

(get-alignment this 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.

axis - may be either X_AXIS or Y_AXIS - int

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 - float

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.

axis - may be either X_AXIS or Y_AXIS - `int`

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 - `float`
raw docstring

get-alt-textclj

(get-alt-text this)

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.

returns: java.lang.String

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.

returns: `java.lang.String`
raw docstring

get-attributesclj

(get-attributes this)

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

returns: javax.swing.text.AttributeSet

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

returns: `javax.swing.text.AttributeSet`
raw docstring

get-imageclj

(get-image this)

Returns the image to render.

returns: java.awt.Image

Returns the image to render.

returns: `java.awt.Image`
raw docstring

get-image-urlclj

(get-image-url this)

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

returns: java.net.URL

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

returns: `java.net.URL`
raw docstring

get-loading-image-iconclj

(get-loading-image-icon this)

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

returns: javax.swing.Icon

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

returns: `javax.swing.Icon`
raw docstring

get-loads-synchronously?clj

(get-loads-synchronously? this)

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

returns: boolean

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

returns: `boolean`
raw docstring

get-no-image-iconclj

(get-no-image-icon this)

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

returns: javax.swing.Icon

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

returns: `javax.swing.Icon`
raw docstring

get-preferred-spanclj

(get-preferred-span this axis)

Determines the preferred span for this view along an axis.

axis - may be either X_AXIS or Y_AXIS - int

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 - float

Determines the preferred span for this view along an
 axis.

axis - may be either X_AXIS or Y_AXIS - `int`

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 - `float`
raw docstring

get-tool-tip-textclj

(get-tool-tip-text this x y allocation)

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

x - float y - float allocation - java.awt.Shape

returns: java.lang.String

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

x - `float`
y - `float`
allocation - `java.awt.Shape`

returns: `java.lang.String`
raw docstring

model-to-viewclj

(model-to-view this pos a b)

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

pos - the position to convert - int a - the allocated region to render into - java.awt.Shape 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 - javax.swing.text.Position$Bias

returns: the bounding box of the given position - java.awt.Shape

throws: javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document

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

pos - the position to convert - `int`
a - the allocated region to render into - `java.awt.Shape`
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 - `javax.swing.text.Position$Bias`

returns: the bounding box of the given position - `java.awt.Shape`

throws: javax.swing.text.BadLocationException - if the given position does not represent a valid location in the associated document
raw docstring

paintclj

(paint this g a)

Paints the View.

g - the rendering surface to use - java.awt.Graphics a - the allocated region to render into - java.awt.Shape

Paints the View.

g - the rendering surface to use - `java.awt.Graphics`
a - the allocated region to render into - `java.awt.Shape`
raw docstring

set-loads-synchronouslyclj

(set-loads-synchronously this new-value)

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.

new-value - boolean

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.

new-value - `boolean`
raw docstring

set-parentclj

(set-parent this parent)

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

parent - the new parent, or null if the view is being removed from a parent - javax.swing.text.View

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

parent - the new parent, or null if the view is being removed from a parent - `javax.swing.text.View`
raw docstring

set-sizeclj

(set-size this width height)

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

width - the width >= 0 - float height - the height >= 0 - float

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

width - the width >= 0 - `float`
height - the height >= 0 - `float`
raw docstring

view-to-modelclj

(view-to-model this x y a bias)

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

x - the X coordinate - float y - the Y coordinate - float a - the allocated region to render into - java.awt.Shape bias - javax.swing.text.Position$Bias[]

returns: the location within the model that best represents the given point of view - int

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

x - the X coordinate - `float`
y - the Y coordinate - `float`
a - the allocated region to render into - `java.awt.Shape`
bias - `javax.swing.text.Position$Bias[]`

returns: the location within the model that best represents the
  given point of view - `int`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close