Package snap.view

Class ImageView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ImageView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

GameActor

public class ImageView
extends View

A View subclass for images.

Field Summary

Fields

Modifier and Type	Field	Description
protected Image	_image
static final String	AllowBleed_Prop
static final String	FillHeight_Prop
static final String	FillWidth_Prop
static final String	Frame_Prop
static final String	Image_Prop
static final String	ImageName_Prop
static final String	KeepAspect_Prop

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, DEFAULT_PADDING, DEFAULT_SPACING, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Managed_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
ImageView()	Constructor.
ImageView(Object aSource)	Constructor for given source URL.
ImageView(Image anImage)	Constructor with given Image.
ImageView(Image anImage, boolean isFillWidth, boolean isFillHeight)	Constructor with given Image and FillWidth/FillHeight params.

Method Summary

Modifier and Type	Method	Description
Object	fromXML(XMLArchiver anArchiver, XMLElement anElement)	XML unarchival.
protected double	getAspect()	Returns the ratio of the width/height.
int	getFrame()	Returns the frame.
int	getFrameCount()	Returns the frame.
int	getFrameMax()	Returns the frame.
Image	getImage()	Returns the image.
Rect	getImageBounds()	Returns the image bounds.
static Rect	getImageBounds(double imageW, double imageH, Rect areaBounds, Pos anAlign, boolean fillWidth, boolean fillHeight, boolean keepAspect)	Returns the image bounds in a given rect.
String	getImageName()	Returns the image name, if loaded from local resource.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
Object	getPropValue(String aPropName)	Returns the value for given key.
boolean	isAllowBleed()	Returns whether image size can extend outside view size.
boolean	isFillHeight()	Returns whether to resize image to fill view height.
boolean	isFillWidth()	Returns whether to resize image to fill view width.
boolean	isKeepAspect()	Returns whether to to preserve aspect ratio of image when resized.
protected void	paintFront(Painter aPntr)	Paints node.
void	setAllowBleed(boolean aValue)	Sets whether image size can extend outside view size.
void	setFillHeight(boolean aValue)	Sets whether to resize image to fill view height.
void	setFillWidth(boolean aValue)	Sets whether to resize image to fill view width.
void	setFrame(int anIndex)	Sets the frame.
void	setImage(Image anImage)	Sets the image.
void	setImageName(String aName)	Sets the image name, if loaded from local resource.
void	setKeepAspect(boolean aValue)	Sets whether to to preserve aspect ratio of image when resized.
void	setPropValue(String aPropName, Object aValue)	Sets the value for given key.
XMLElement	toXML(XMLArchiver anArchiver)	XML archival.

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, containsShape, createActionEvent, disableEvents, enableEvents, fireActionEvent, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultBorder, getDefaultFill, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRootView, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getToolTip, getTransX, getTransY, getUpdater, getValuePropName, getVisRect, getWidth, getWindow, getX, getXY, getY, indexInHost, indexInParent, initProps, intersectsShape, isActionable, isAncestor, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isShowing, isToolTipEnabled, isVertical, isVisible, localToParent, localToParent, localToParent, localToParent, localToScreen, paintAll, paintBack, parentFontChanged, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventAll, processEventFilters, processEventHandlers, relayout, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaint, repaintInParent, requestFocus, runDelayed, runIntervals, runLater, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimProps, setAnimString, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocused, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setFont, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setOwner, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setShowing, setSize, setSize, setSizeLocal, setSizeToBestSize, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setVisible, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, stopIntervals, themeChanged, toStringProps

Methods inherited from class snap.props.PropObject

addDeepChangeListener, addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, getPropsString, isPropDefault, processPropChange, removeDeepChangeListener, removePropChangeListener, removePropChangeListener, setPropsString, setPropValues, toString

Methods inherited from class java.lang.Object

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

Field Details

_image

protected Image _image

Image_Prop

public static final String Image_Prop

See Also:

• Constant Field Values

ImageName_Prop

public static final String ImageName_Prop

See Also:

• Constant Field Values

FillWidth_Prop

public static final String FillWidth_Prop

See Also:

• Constant Field Values

FillHeight_Prop

public static final String FillHeight_Prop

See Also:

• Constant Field Values

KeepAspect_Prop

public static final String KeepAspect_Prop

See Also:

• Constant Field Values

AllowBleed_Prop

public static final String AllowBleed_Prop

See Also:

• Constant Field Values

Frame_Prop

public static final String Frame_Prop

See Also:

• Constant Field Values

Constructor Details

ImageView

public ImageView()

Constructor.

ImageView

public ImageView(Image anImage)

Constructor with given Image.

ImageView

public ImageView(Image anImage,
 boolean isFillWidth,
 boolean isFillHeight)

Constructor with given Image and FillWidth/FillHeight params.

ImageView

public ImageView(Object aSource)

Constructor for given source URL.

Method Details

getImage

public Image getImage()

Returns the image.

setImage

public void setImage(Image anImage)

Sets the image.

getImageName

public String getImageName()

Returns the image name, if loaded from local resource.

setImageName

public void setImageName(String aName)

Sets the image name, if loaded from local resource.

isFillWidth

public boolean isFillWidth()

Returns whether to resize image to fill view width.

setFillWidth

public void setFillWidth(boolean aValue)

Sets whether to resize image to fill view width.

isFillHeight

public boolean isFillHeight()

Returns whether to resize image to fill view height.

setFillHeight

public void setFillHeight(boolean aValue)

Sets whether to resize image to fill view height.

isKeepAspect

public boolean isKeepAspect()

Returns whether to to preserve aspect ratio of image when resized.

setKeepAspect

public void setKeepAspect(boolean aValue)

Sets whether to to preserve aspect ratio of image when resized.

isAllowBleed

public boolean isAllowBleed()

Returns whether image size can extend outside view size.

setAllowBleed

public void setAllowBleed(boolean aValue)

Sets whether image size can extend outside view size.

getFrame

public int getFrame()

Returns the frame.

setFrame

public void setFrame(int anIndex)

Sets the frame.

getFrameMax

public int getFrameMax()

Returns the frame.

getFrameCount

public int getFrameCount()

Returns the frame.

getImageBounds

public Rect getImageBounds()

Returns the image bounds.

getImageBounds

public static Rect getImageBounds(double imageW,
 double imageH,
 Rect areaBounds,
 Pos anAlign,
 boolean fillWidth,
 boolean fillHeight,
 boolean keepAspect)

Returns the image bounds in a given rect.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the preferred height.

Overrides:

getPrefHeightImpl in class View

getAspect

protected double getAspect()

Returns the ratio of the width/height.

paintFront

protected void paintFront(Painter aPntr)

Paints node.

Overrides:

paintFront in class View

getPropValue

public Object getPropValue(String aPropName)

Returns the value for given key.

Overrides:

getPropValue in class View

setPropValue

public void setPropValue(String aPropName,
 Object aValue)

Sets the value for given key.

Overrides:

setPropValue in class View

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

Specified by:

toXML in interface XMLArchiver.Archivable

Overrides:

toXML in class View

fromXML

public Object fromXML(XMLArchiver anArchiver,
 XMLElement anElement)

XML unarchival.

Specified by:

fromXML in interface XMLArchiver.Archivable

Overrides:

fromXML in class View