OImageView (ontimize-core 5.6.0 API)

java.lang.Object
- javax.swing.text.View
- - com.ontimize.gui.field.html.utils.OImageView

All Implemented Interfaces:

SwingConstants
```
public class OImageView
extends View
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`OImageView.ImageHandler` ImageHandler implements the ImageObserver to correctly update the display as new parts of the image become available.
`protected class`	`OImageView.ImageLabelView` ImageLabelView is used if the image can't be loaded, and the attribute specified an alt attribute.

Field Summary

Fields
Modifier and Type	Field and Description
`protected View`	`altView` Used for alt text.
`protected AttributeSet`	`attr`
`protected Color`	`borderColor`
`protected short`	`borderSize`
`protected short`	`bottomInset`
`protected Container`	`container`
`protected static int`	`DEFAULT_BORDER` Default border to use if one is not specified.
`protected static int`	`DEFAULT_HEIGHT`
`protected static int`	`DEFAULT_WIDTH`
`protected Rectangle`	`fBounds`
`protected int`	`height`
`protected static int`	`HEIGHT_FLAG`
`protected Image`	`image`
`protected static String`	`IMAGE_CACHE_PROPERTY` Document property for image cache.
`protected ImageObserver`	`imageObserver` We don't directly implement ImageObserver, instead we use an instance that calls back to us.
`protected short`	`leftInset`
`protected static int`	`LINK_FLAG`
`protected static int`	`LOADING_FLAG`
`protected static String`	`MISSING_IMAGE` Property name for missing image icon
`protected static String`	`PENDING_IMAGE` Property name for pending image icon
`protected static int`	`RELOAD_FLAG`
`protected static int`	`RELOAD_IMAGE_FLAG`
`protected short`	`rightInset`
`protected static int`	`sIncRate` Repaint delay when some of the bits are available.
`protected static boolean`	`sIsInc` If true, when some of the bits are available a repaint is done.
`protected int`	`state` Bitmask containing some of the above bitmask values.
`protected static int`	`SYNC_LOAD_FLAG`
`protected short`	`topInset`
`protected float`	`vAlign` Alignment along the vertical (Y) axis.
`protected int`	`width`
`protected static int`	`WIDTH_FLAG`

Fields inherited from class javax.swing.text.View
BadBreakWeight, ExcellentBreakWeight, ForcedBreakWeight, GoodBreakWeight, X_AXIS, Y_AXIS

Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors
Constructor and Description

OImageView(Element elem)
Creates a new view that represents an IMG element.

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

Method Summary

Methods
Modifier and Type	Method and 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 can't be loaded.
`protected View`	`getAltView()` Returns the view to use for alternate text.
`AttributeSet`	`getAttributes()` Fetches the attributes to use when rendering.
`Image`	`getEmbedImage()`
`Image`	`getImage()` Returns the image to render.
`URL`	`getImageURL()` Return a URL for the image source, or null if it could not be determined.
`protected int`	`getIntAttr(HTML.Attribute name, int deflt)` Convenience method for getting an integer attribute from the elements AttributeSet.
`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.
`protected float`	`getPreferredSpanFromAltView(int axis)` Returns the preferred span of the View used to display the alt text, or 0 if the view does not exist.
`protected StyleSheet`	`getStyleSheet()` Convenience 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.
`protected boolean`	`hasPixels(Image image)` Returns true if the passed in image has a non-zero width and height.
`protected boolean`	`isLink()` Returns true if this image within a link?
`protected void`	`loadImage()` Loads the image from the URL `getImageURL`.
`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.
`protected void`	`paintBorder(Graphics g, Rectangle rect)`
`protected void`	`paintHighlights(Graphics g, Shape shape)`
`protected void`	`refreshImage()` Loads the image and updates the size accordingly.
`protected void`	`repaint(long delay)` Request that this view be repainted.
`protected void`	`safePreferenceChanged()` Invokes `preferenceChanged` on the event displatching thread.
`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.
`protected void`	`sync()` Makes sure the necessary properties and image is loaded.
`protected void`	`updateAltTextView()` Updates the view representing the alt text.
`protected void`	`updateImageSize()` Recreates and reloads the image.
`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 inherited from class javax.swing.text.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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sIsInc
```
protected static boolean sIsInc
```
    If true, when some of the bits are available a repaint is done.
    This is set to false as swing does not offer a repaint that takes a delay. If this were true, a bunch of immediate repaints would get generated that end up significantly delaying the loading of the image (or anything else going on for that matter).
  - sIncRate
```
protected static int sIncRate
```
    Repaint delay when some of the bits are available.
  - PENDING_IMAGE
```
protected static final String PENDING_IMAGE
```
    Property name for pending image icon
    
    See Also:
    Constant Field Values
  - MISSING_IMAGE
```
protected static final String MISSING_IMAGE
```
    Property name for missing image icon
    
    See Also:
    Constant Field Values
  - IMAGE_CACHE_PROPERTY
```
protected static final String IMAGE_CACHE_PROPERTY
```
    Document property for image cache.
    
    See Also:
    Constant Field Values
  - DEFAULT_WIDTH
```
protected static final int DEFAULT_WIDTH
```
    See Also:
    Constant Field Values
  - DEFAULT_HEIGHT
```
protected static final int DEFAULT_HEIGHT
```
    See Also:
    Constant Field Values
  - DEFAULT_BORDER
```
protected static final int DEFAULT_BORDER
```
    Default border to use if one is not specified.
    
    See Also:
    Constant Field Values
  - LOADING_FLAG
```
protected static final int LOADING_FLAG
```
    See Also:
    Constant Field Values
  - LINK_FLAG
```
protected static final int LINK_FLAG
```
    See Also:
    Constant Field Values
  - WIDTH_FLAG
```
protected static final int WIDTH_FLAG
```
    See Also:
    Constant Field Values
  - HEIGHT_FLAG
```
protected static final int HEIGHT_FLAG
```
    See Also:
    Constant Field Values
  - RELOAD_FLAG
```
protected static final int RELOAD_FLAG
```
    See Also:
    Constant Field Values
  - RELOAD_IMAGE_FLAG
```
protected static final int RELOAD_IMAGE_FLAG
```
    See Also:
    Constant Field Values
  - SYNC_LOAD_FLAG
```
protected static final int SYNC_LOAD_FLAG
```
    See Also:
    Constant Field Values
  - attr
```
protected AttributeSet attr
```
  - image
```
protected Image image
```
  - width
```
protected int width
```
  - height
```
protected int height
```
  - state
```
protected int state
```
    Bitmask containing some of the above bitmask values. Because the image loading notification can happen on another thread access to this is synchronized (at least for modifying it).
  - container
```
protected Container container
```
  - fBounds
```
protected Rectangle fBounds
```
  - borderColor
```
protected Color borderColor
```
  - borderSize
```
protected short borderSize
```
  - leftInset
```
protected short leftInset
```
  - rightInset
```
protected short rightInset
```
  - topInset
```
protected short topInset
```
  - bottomInset
```
protected short bottomInset
```
  - imageObserver
```
protected ImageObserver imageObserver
```
    We don't directly implement ImageObserver, instead we use an instance that calls back to us.
  - altView
```
protected View altView
```
    Used for alt text. Will be non-null if the image couldn't be found, and there is valid alt text.
  - vAlign
```
protected float vAlign
```
    Alignment along the vertical (Y) axis.
- Constructor Detail
  - OImageView
```
public OImageView(Element elem)
```
    Creates a new view that represents an IMG element.
    
    Parameters:
    elem - the element to create a view for
- Method Detail
  - getAltText
```
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.
  - getImageURL
```
public URL getImageURL()
```
    Return a URL for the image source, or null if it could not be determined.
  - getEmbedImage
```
public Image getEmbedImage()
```
  - getNoImageIcon
```
public Icon getNoImageIcon()
```
    Returns the icon to use if the image couldn't be found.
  - getLoadingImageIcon
```
public Icon getLoadingImageIcon()
```
    Returns the icon to use while in the process of loading the image.
  - getImage
```
public Image getImage()
```
    Returns the image to render.
  - setLoadsSynchronously
```
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.
  - getLoadsSynchronously
```
public boolean getLoadsSynchronously()
```
    Returns true if the image should be loaded when first asked for.
  - getStyleSheet
```
protected StyleSheet getStyleSheet()
```
    Convenience method to get 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
  - 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 overriden to return getAltText.
    
    Overrides:
    
    getToolTipText in class View
    
    See Also:
    JTextComponent.getToolTipText(java.awt.event.MouseEvent)
  - 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
  - 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
  - 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:
    View.paint(java.awt.Graphics, java.awt.Shape)
  - paintHighlights
```
protected void paintHighlights(Graphics g,
                   Shape shape)
```
  - paintBorder
```
protected void paintBorder(Graphics g,
               Rectangle rect)
```
  - 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
    
    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:
    View.modelToView(int, java.awt.Shape, javax.swing.text.Position.Bias)
  - 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
    
    Returns:
    the location within the model that best represents the given point of view
    See Also:
    View.viewToModel(float, float, java.awt.Shape, javax.swing.text.Position.Bias[])
  - 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
  - isLink
```
protected boolean isLink()
```
    Returns true if this image within a link?
  - hasPixels
```
protected boolean hasPixels(Image image)
```
    Returns true if the passed in image has a non-zero width and height.
  - getPreferredSpanFromAltView
```
protected float getPreferredSpanFromAltView(int axis)
```
    Returns the preferred span of the View used to display the alt text, or 0 if the view does not exist.
  - repaint
```
protected void repaint(long delay)
```
    Request that this view be repainted. Assumes the view is still at its last-drawn location.
  - getIntAttr
```
protected int getIntAttr(HTML.Attribute name,
             int deflt)
```
    Convenience method for getting an integer attribute from the elements AttributeSet.
  - sync
```
protected void sync()
```
    Makes sure the necessary properties and image is loaded.
  - refreshImage
```
protected void refreshImage()
```
    Loads the image and updates the size accordingly. This should be invoked instead of invoking loadImage or updateImageSize directly.
  - loadImage
```
protected void loadImage()
```
    Loads the image from the URL getImageURL. This should only be invoked from refreshImage.
  - updateImageSize
```
protected void updateImageSize()
```
    Recreates and reloads the image. This should only be invoked from refreshImage.
  - updateAltTextView
```
protected void updateAltTextView()
```
    Updates the view representing the alt text.
  - getAltView
```
protected View getAltView()
```
    Returns the view to use for alternate text. This may be null.
  - safePreferenceChanged
```
protected void safePreferenceChanged()
```
    Invokes preferenceChanged on the event displatching thread.

Class OImageView

Nested Class Summary

Field Summary

Fields inherited from class javax.swing.text.View

Fields inherited from interface javax.swing.SwingConstants

Constructor Summary

Method Summary

Methods inherited from class javax.swing.text.View

Methods inherited from class java.lang.Object

Field Detail

sIsInc

sIncRate

PENDING_IMAGE

MISSING_IMAGE

IMAGE_CACHE_PROPERTY

DEFAULT_WIDTH

DEFAULT_HEIGHT

DEFAULT_BORDER

LOADING_FLAG

LINK_FLAG

WIDTH_FLAG

HEIGHT_FLAG

RELOAD_FLAG

RELOAD_IMAGE_FLAG

SYNC_LOAD_FLAG

attr

image

width

height

state

container

fBounds

borderColor

borderSize

leftInset

rightInset

topInset

bottomInset

imageObserver

altView

vAlign

Constructor Detail

OImageView

Method Detail

getAltText

getImageURL

getEmbedImage

getNoImageIcon

getLoadingImageIcon

getImage

setLoadsSynchronously

getLoadsSynchronously

getStyleSheet

getAttributes

getToolTipText

setPropertiesFromAttributes

setParent

changedUpdate

paint

paintHighlights

paintBorder

getPreferredSpan

getAlignment

modelToView

viewToModel

setSize

isLink

hasPixels

getPreferredSpanFromAltView

repaint

getIntAttr

sync

refreshImage

loadImage

updateImageSize

updateAltTextView

getAltView

safePreferenceChanged