org.apache.pivot.wtk.skin
Class ImageViewSkin

java.lang.Object
  extended by org.apache.pivot.wtk.skin.ComponentSkin
      extended by org.apache.pivot.wtk.skin.ImageViewSkin
All Implemented Interfaces:
ComponentKeyListener, ComponentListener, ComponentMouseButtonListener, ComponentMouseListener, ComponentMouseWheelListener, ComponentStateListener, ComponentTooltipListener, ConstrainedVisual, ImageViewListener, Skin, Visual

public class ImageViewSkin
extends ComponentSkin
implements ImageViewListener

Image view skin.

TODO Add a rotation (float) style.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ImageViewListener
ImageViewListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentListener
ComponentListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentStateListener
ComponentStateListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseListener
ComponentMouseListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentMouseButtonListener
ComponentMouseButtonListener.Adapter
 
Nested classes/interfaces inherited from interface org.apache.pivot.wtk.ComponentKeyListener
ComponentKeyListener.Adapter
 
Constructor Summary
ImageViewSkin()
           
 
Method Summary
 void asynchronousChanged(ImageView imageView)
          Called when an image view's asynchronous flag has changed.
 Color getBackgroundColor()
          Returns the color that is painted behind the image
 int getBaseline(int width, int height)
          Returns the baseline for a given width and height.
 boolean getFill()
          Returns a boolean indicating whether the image will be scaled to fit the space in which it is placed.
 HorizontalAlignment getHorizontalAlignment()
          Returns the horizontal alignment of the image.
 float getOpacity()
          Returns the opacity of the image, in [0,1].
 int getPreferredHeight(int width)
          Returns the visual's preferred height given the provided width constraint.
 Dimensions getPreferredSize()
          Returns the visual's unconstrained preferred size.
 int getPreferredWidth(int height)
          Returns the visual's preferred width given the provided height constraint.
 boolean getPreserveAspectRatio()
          Returns a boolean indicating whether, when the image is scaled, its aspect ratio is preserved.
 VerticalAlignment getVerticalAlignment()
          Returns the vertical alignment of the image.
 void imageChanged(ImageView imageView, Image previousImage)
          Called when an image view's image has changed.
 void install(Component component)
          Associates a skin with a component.
 boolean isFocusable()
          By default, skins are focusable.
 boolean isOpaque()
          By default, skins are assumed to be opaque.
 void layout()
          If the component on which the skin is installed is a container, lays out the container's children.
 void paint(Graphics2D graphics)
          Paints the visual.
 void setBackgroundColor(Color backgroundColor)
          Sets the color that is painted behind the image
 void setBackgroundColor(String backgroundColor)
          Sets the color that is painted behind the image
 void setFill(boolean fill)
          Sets a boolean indicating whether the image will be scaled to fit the space in which it is placed.
 void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
          Sets the horizontal alignment of the image.
 void setOpacity(float opacity)
          Sets the opacity of the image.
 void setOpacity(Number opacity)
          Sets the opacity of the image.
 void setPreserveAspectRatio(boolean preserveAspectRatio)
          Sets a boolean indicating whether, when the image is scaled, its aspect ratio is preserved.
 void setVerticalAlignment(VerticalAlignment verticalAlignment)
          Sets the vertical alignment of the image.
 
Methods inherited from class org.apache.pivot.wtk.skin.ComponentSkin
cursorChanged, decodeFont, dragSourceChanged, dropTargetChanged, enabledChanged, focusedChanged, getBaseline, getComponent, getHeight, getWidth, heightLimitsChanged, invalidateComponent, keyPressed, keyReleased, keyTyped, locationChanged, menuHandlerChanged, mouseClick, mouseDown, mouseMove, mouseOut, mouseOver, mouseUp, mouseWheel, nameChanged, parentChanged, preferredSizeChanged, repaintComponent, repaintComponent, repaintComponent, repaintComponent, repaintComponent, setSize, sizeChanged, tooltipDelayChanged, tooltipTextChanged, tooltipTriggered, visibleChanged, widthLimitsChanged
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageViewSkin

public ImageViewSkin()
Method Detail

install

public void install(Component component)
Description copied from interface: Skin
Associates a skin with a component.

Specified by:
install in interface Skin
Overrides:
install in class ComponentSkin
Parameters:
component - The component to which the skin is being attached.

getPreferredWidth

public int getPreferredWidth(int height)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred width given the provided height constraint.

Specified by:
getPreferredWidth in interface ConstrainedVisual
Parameters:
height - The height by which to constrain the preferred width, or -1 for no constraint.

getPreferredHeight

public int getPreferredHeight(int width)
Description copied from interface: ConstrainedVisual
Returns the visual's preferred height given the provided width constraint.

Specified by:
getPreferredHeight in interface ConstrainedVisual
Parameters:
width - The width by which to constrain the preferred height, or -1 for no constraint.

getPreferredSize

public Dimensions getPreferredSize()
Description copied from interface: ConstrainedVisual
Returns the visual's unconstrained preferred size.

Specified by:
getPreferredSize in interface ConstrainedVisual
Overrides:
getPreferredSize in class ComponentSkin

getBaseline

public int getBaseline(int width,
                       int height)
Description copied from interface: ConstrainedVisual
Returns the baseline for a given width and height.

Specified by:
getBaseline in interface ConstrainedVisual
Overrides:
getBaseline in class ComponentSkin
Returns:
The baseline relative to the origin of this visual, or -1 if this visual does not have a baseline.

layout

public void layout()
Description copied from interface: Skin
If the component on which the skin is installed is a container, lays out the container's children.

Specified by:
layout in interface Skin

paint

public void paint(Graphics2D graphics)
Description copied from interface: Visual
Paints the visual.

Specified by:
paint in interface Visual
Parameters:
graphics - The graphics context in which to paint the visual.

isFocusable

public boolean isFocusable()
Description copied from class: ComponentSkin
By default, skins are focusable.

Specified by:
isFocusable in interface Skin
Overrides:
isFocusable in class ComponentSkin
Returns:
false; image views are not focusable.

isOpaque

public boolean isOpaque()
Description copied from class: ComponentSkin
By default, skins are assumed to be opaque.

Specified by:
isOpaque in interface Skin
Overrides:
isOpaque in class ComponentSkin
Returns:
true if this skin is opaque; false if any part of it is transparent or translucent.

getBackgroundColor

public Color getBackgroundColor()
Returns the color that is painted behind the image


setBackgroundColor

public void setBackgroundColor(Color backgroundColor)
Sets the color that is painted behind the image


setBackgroundColor

public final void setBackgroundColor(String backgroundColor)
Sets the color that is painted behind the image

Parameters:
backgroundColor - Any of the color values recognized by Pivot.

getOpacity

public float getOpacity()
Returns the opacity of the image, in [0,1].


setOpacity

public void setOpacity(float opacity)
Sets the opacity of the image.

Parameters:
opacity - A number between 0 (transparent) and 1 (opaque)

setOpacity

public final void setOpacity(Number opacity)
Sets the opacity of the image.

Parameters:
opacity - A number between 0 (transparent) and 1 (opaque)

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()
Returns the horizontal alignment of the image.


setHorizontalAlignment

public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment)
Sets the horizontal alignment of the image. Ignored if the fill style is true.


getVerticalAlignment

public VerticalAlignment getVerticalAlignment()
Returns the vertical alignment of the image.


setVerticalAlignment

public void setVerticalAlignment(VerticalAlignment verticalAlignment)
Sets the vertical alignment of the image. Ignored if the fill style is true.


getFill

public boolean getFill()
Returns a boolean indicating whether the image will be scaled to fit the space in which it is placed.


setFill

public void setFill(boolean fill)
Sets a boolean indicating whether the image will be scaled to fit the space in which it is placed. Note that for scaling to occur, the ImageView must specify a preferred size or be placed in a container that constrains its size.


getPreserveAspectRatio

public boolean getPreserveAspectRatio()
Returns a boolean indicating whether, when the image is scaled, its aspect ratio is preserved.


setPreserveAspectRatio

public void setPreserveAspectRatio(boolean preserveAspectRatio)
Sets a boolean indicating whether, when the image is scaled, its aspect ratio is preserved. Ignored if the fill style is false.


imageChanged

public void imageChanged(ImageView imageView,
                         Image previousImage)
Description copied from interface: ImageViewListener
Called when an image view's image has changed.

Specified by:
imageChanged in interface ImageViewListener

asynchronousChanged

public void asynchronousChanged(ImageView imageView)
Description copied from interface: ImageViewListener
Called when an image view's asynchronous flag has changed.

Specified by:
asynchronousChanged in interface ImageViewListener