com.qozix.layouts

Class ZoomPanLayout

java.lang.Object

ViewGroup

com.qozix.layouts.ZoomPanLayout

Direct Known Subclasses:

MapView

public class ZoomPanLayout
extends ViewGroup

ZoomPanLayout extends ViewGroup to provide support for scrolling and zooming. Fling, drag, pinch and double-tap events are supported natively. ZoomPanLayout does not support direct insertion of child Views, and manages positioning through an intermediary View. the addChild method provides an interface to add layouts to that intermediary view. Each of these children are provided with LayoutParams of MATCH_PARENT for both axes, and will always be positioned at 0,0, so should generally be ViewGroups themselves (RelativeLayouts or FrameLayouts are generally appropriate).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZoomPanLayout.GestureListener
static interface	ZoomPanLayout.ZoomPanListener

Constructor Summary

Constructors

Constructor and Description
ZoomPanLayout(Context context) Constructor to use when creating a ZoomPanLayout from code.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(View child) Adds a View to the intermediary ViewGroup that manages layout for the ZoomPanLayout.
boolean	addGestureListener(ZoomPanLayout.GestureListener listener) Adds a GestureListener to the ZoomPanLayout, which will receive gesture events
void	addView(View child)
boolean	addZoomPanListener(ZoomPanLayout.ZoomPanListener listener) Adds a ZoomPanListener to the ZoomPanLayout, which will receive events relating to zoom and pan actions
void	computeScroll()
int	getBaseHeight() Returns the base (un-scaled) height
int	getBaseWidth() Returns the base (un-scaled) width
double	getScale() Retrieves the current scale of the ZoomPanLayout
int	getScaledHeight() Returns the scaled height
int	getScaledWidth() Returns the scaled width
boolean	isFlinging() Returns whether the ZoomPanLayout is currently being flung
boolean	onInterceptTouchEvent(MotionEvent event)
boolean	onTouchEvent(MotionEvent event)
void	removeChild(View child) Removes a View from the intermediary ViewGroup that manages layout for this ZoomPanLayout
boolean	removeGestureListener(ZoomPanLayout.GestureListener listener) Removes a GestureListener from the ZoomPanLayout
void	removeView(View child)
boolean	removeZoomPanListener(ZoomPanLayout.ZoomPanListener listener) Removes a ZoomPanListener from the ZoomPanLayout
void	scrollToAndCenter(Point point) Scrolls and centers the ZoomPanLayout to the x and y values specified by Point
void	scrollToPoint(Point point) Scrolls the ZoomPanLayout to the x and y values specified by Point
void	setScale(double d) Sets the scale (0-1) of the ZoomPanLayout
void	setScaleLimits(double min, double max) Set minimum and maximum scale values for this ZoomPanLayout.
void	setScaleToFit(boolean shouldScaleToFit) Determines whether the ZoomPanLayout should limit it's minimum scale to no less than what would be required to fill it's container
void	setShouldIntercept(boolean intercept) Sets whether the ZoomPanLayout should intercept touch events on it's child views.
void	setSize(int wide, int tall) Sets the size (width and height) of the ZoomPanLayout as it should be rendered at a scale of 1f (100%)
void	slideToAndCenter(Point point) Scrolls and centers the ZoomPanLayout to the x and y values specified by Point using scrolling animation
void	slideToPoint(Point point) Scrolls the ZoomPanLayout to the x and y values specified by Point using scrolling animation
void	smoothScaleTo(double destination, int duration) Scales the ZoomPanLayout with animated progress

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoomPanLayout

public ZoomPanLayout(Context context)

Constructor to use when creating a ZoomPanLayout from code. Inflating from XML is not currently supported.

Parameters:

context - (Context) The Context the ZoomPanLayout is running in, through which it can access the current theme, resources, etc.

Method Detail

setScaleToFit

public void setScaleToFit(boolean shouldScaleToFit)

Determines whether the ZoomPanLayout should limit it's minimum scale to no less than what would be required to fill it's container

Parameters:

shouldScaleToFit - (boolean) True to limit minimum scale, false to allow arbitrary minimum scale (see setScaleLimits)

setScaleLimits

public void setScaleLimits(double min,
                  double max)

Set minimum and maximum scale values for this ZoomPanLayout. Note that if shouldScaleToFit is set to true, the minimum value set here will be ignored Default values are 0 and 1.

Parameters:

min -

max -

setShouldIntercept

public void setShouldIntercept(boolean intercept)

Sets whether the ZoomPanLayout should intercept touch events on it's child views. If true, the ZoomPanLayout will intercept touch events, so that touch events on child views will not consume the event, so gestures (drag, fling) on the ZoomPanLayout will not be interrupted. If false, child views will consume touch events normally, and will interrupt gesture events on the containing ZoomPanLayout

Parameters:

intercept - (boolean) Boolean value indicating whether the ZoomPanLayout should intercept touch events

setSize

public void setSize(int wide,
           int tall)

Sets the size (width and height) of the ZoomPanLayout as it should be rendered at a scale of 1f (100%)

Parameters:

wide - width

tall - height

getBaseWidth

public int getBaseWidth()

Returns the base (un-scaled) width

Returns:

(int) base width

getBaseHeight

public int getBaseHeight()

Returns the base (un-scaled) height

Returns:

(int) base height

getScaledWidth

public int getScaledWidth()

Returns the scaled width

Returns:

(int) scaled width

getScaledHeight

public int getScaledHeight()

Returns the scaled height

Returns:

(int) scaled height

setScale

public void setScale(double d)

Sets the scale (0-1) of the ZoomPanLayout

Parameters:

scale - (double) The new value of the ZoomPanLayout scale

getScale

public double getScale()

Retrieves the current scale of the ZoomPanLayout

Returns:

(double) the current scale of the ZoomPanLayout

isFlinging

public boolean isFlinging()

Returns whether the ZoomPanLayout is currently being flung

Returns:

(boolean) true if the ZoomPanLayout is currently flinging, false otherwise

addGestureListener

public boolean addGestureListener(ZoomPanLayout.GestureListener listener)

Adds a GestureListener to the ZoomPanLayout, which will receive gesture events

Parameters:

listener - (GestureListener) Listener to add

Returns:

(boolean) true when the listener set did not already contain the Listener, false otherwise

removeGestureListener

public boolean removeGestureListener(ZoomPanLayout.GestureListener listener)

Removes a GestureListener from the ZoomPanLayout

Parameters:

listener - (GestureListener) Listener to remove

Returns:

(boolean) if the Listener was removed, false otherwise

addZoomPanListener

public boolean addZoomPanListener(ZoomPanLayout.ZoomPanListener listener)

Adds a ZoomPanListener to the ZoomPanLayout, which will receive events relating to zoom and pan actions

Parameters:

listener - (ZoomPanListener) Listener to add

Returns:

(boolean) true when the listener set did not already contain the Listener, false otherwise

removeZoomPanListener

public boolean removeZoomPanListener(ZoomPanLayout.ZoomPanListener listener)

Removes a ZoomPanListener from the ZoomPanLayout

Parameters:

listener - (ZoomPanListener) Listener to remove

Returns:

(boolean) if the Listener was removed, false otherwise

scrollToPoint

public void scrollToPoint(Point point)

Scrolls the ZoomPanLayout to the x and y values specified by Point

Parameters:

point - (Point) Point instance containing the destination x and y values

scrollToAndCenter

public void scrollToAndCenter(Point point)

Scrolls and centers the ZoomPanLayout to the x and y values specified by Point

Parameters:

point - (Point) Point instance containing the destination x and y values

slideToPoint

public void slideToPoint(Point point)

Scrolls the ZoomPanLayout to the x and y values specified by Point using scrolling animation

Parameters:

point - (Point) Point instance containing the destination x and y values

slideToAndCenter

public void slideToAndCenter(Point point)

Scrolls and centers the ZoomPanLayout to the x and y values specified by Point using scrolling animation

Parameters:

point - (Point) Point instance containing the destination x and y values

addChild

public void addChild(View child)

Adds a View to the intermediary ViewGroup that manages layout for the ZoomPanLayout. This View will be laid out at the width and height specified by at 0, 0

Parameters:

child - (View) The View to be added to the ZoomPanLayout view tree

removeChild

public void removeChild(View child)

Removes a View from the intermediary ViewGroup that manages layout for this ZoomPanLayout

Parameters:

child - (View) The View to be removed

smoothScaleTo

public void smoothScaleTo(double destination,
                 int duration)

Scales the ZoomPanLayout with animated progress

Parameters:

destination - (double) The final scale to animate to

duration - (int) The duration (in milliseconds) of the animation

computeScroll

public void computeScroll()

addView

public void addView(View child)

removeView

public void removeView(View child)

onInterceptTouchEvent

public boolean onInterceptTouchEvent(MotionEvent event)

onTouchEvent

public boolean onTouchEvent(MotionEvent event)