Skip to content

Most visited

Recently visited

navigation

ZoomButtonsController

public class ZoomButtonsController
extends Object implements View.OnTouchListener

java.lang.Object
   ↳ android.widget.ZoomButtonsController


The ZoomButtonsController handles showing and hiding the zoom controls and positioning it relative to an owner view. It also gives the client access to the zoom controls container, allowing for additional accessory buttons to be shown in the zoom controls window.

Typically, clients should call setVisible(true) on a touch down or move (no need to call setVisible(false) since it will time out on its own). Also, whenever the owner cannot be zoomed further, the client should update setZoomInEnabled(boolean) and setZoomOutEnabled(boolean).

If you are using this with a custom View, please call setVisible(false) from onDetachedFromWindow() and from onVisibilityChanged(View, int) when visibility != View.VISIBLE.

Summary

Nested classes

interface ZoomButtonsController.OnZoomListener

Interface that will be called when the user performs an interaction that triggers some action, for example zooming. 

Public constructors

ZoomButtonsController(View ownerView)

Constructor for the ZoomButtonsController.

Public methods

ViewGroup getContainer()

Gets the container that is the parent of the zoom controls.

View getZoomControls()

Gets the view for the zoom controls.

boolean isAutoDismissed()

Whether the zoom controls will be automatically dismissed after showing.

boolean isVisible()

Whether the zoom controls are visible to the user.

void setAutoDismissed(boolean autoDismiss)

Sets whether the zoom controls will be automatically dismissed after showing.

void setFocusable(boolean focusable)

Sets whether the zoom controls should be focusable.

void setOnZoomListener(ZoomButtonsController.OnZoomListener listener)

Sets the ZoomButtonsController.OnZoomListener listener that receives callbacks to zoom.

void setVisible(boolean visible)

Sets whether the zoom controls should be visible to the user.

void setZoomInEnabled(boolean enabled)

Whether to enable the zoom in control.

void setZoomOutEnabled(boolean enabled)

Whether to enable the zoom out control.

void setZoomSpeed(long speed)

Sets the delay between zoom callbacks as the user holds a zoom button.

Inherited methods

From class java.lang.Object
From interface android.view.View.OnTouchListener

Public constructors

ZoomButtonsController

Added in API level 4
ZoomButtonsController (View ownerView)

Constructor for the ZoomButtonsController.

Parameters
ownerView View: The view that is being zoomed by the zoom controls. The zoom controls will be displayed aligned with this view.

Public methods

getContainer

Added in API level 4
ViewGroup getContainer ()

Gets the container that is the parent of the zoom controls.

The client can add other views to this container to link them with the zoom controls.

Returns
ViewGroup The container of the zoom controls. It will be a layout that respects the gravity of a child's layout parameters.

getZoomControls

Added in API level 4
View getZoomControls ()

Gets the view for the zoom controls.

Returns
View The zoom controls view.

isAutoDismissed

Added in API level 4
boolean isAutoDismissed ()

Whether the zoom controls will be automatically dismissed after showing.

Returns
boolean Whether the zoom controls will be auto dismissed after showing.

isVisible

Added in API level 4
boolean isVisible ()

Whether the zoom controls are visible to the user.

Returns
boolean Whether the zoom controls are visible to the user.

setAutoDismissed

Added in API level 4
void setAutoDismissed (boolean autoDismiss)

Sets whether the zoom controls will be automatically dismissed after showing.

Parameters
autoDismiss boolean

setFocusable

Added in API level 4
void setFocusable (boolean focusable)

Sets whether the zoom controls should be focusable. If the controls are focusable, then trackball and arrow key interactions are possible. Otherwise, only touch interactions are possible.

Parameters
focusable boolean: Whether the zoom controls should be focusable.

setOnZoomListener

Added in API level 4
void setOnZoomListener (ZoomButtonsController.OnZoomListener listener)

Sets the ZoomButtonsController.OnZoomListener listener that receives callbacks to zoom.

Parameters
listener ZoomButtonsController.OnZoomListener: The listener that will be told to zoom.

setVisible

Added in API level 4
void setVisible (boolean visible)

Sets whether the zoom controls should be visible to the user.

Parameters
visible boolean: Whether the zoom controls should be visible to the user.

setZoomInEnabled

Added in API level 4
void setZoomInEnabled (boolean enabled)

Whether to enable the zoom in control.

Parameters
enabled boolean: Whether to enable the zoom in control.

setZoomOutEnabled

Added in API level 4
void setZoomOutEnabled (boolean enabled)

Whether to enable the zoom out control.

Parameters
enabled boolean: Whether to enable the zoom out control.

setZoomSpeed

Added in API level 4
void setZoomSpeed (long speed)

Sets the delay between zoom callbacks as the user holds a zoom button.

Parameters
speed long: The delay in milliseconds between zoom callbacks.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.