Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ZoomButtonsController

extends Object
implements View.OnTouchListener
java.lang.Object
   ↳ android.widget.ZoomButtonsController

Class Overview

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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.view.View.OnTouchListener

Public Constructors

public ZoomButtonsController ( View ownerView)

Added in API level 4

Constructor for the ZoomButtonsController .

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

Public Methods

public ViewGroup getContainer ()

Added in API level 4

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
  • The container of the zoom controls. It will be a layout that respects the gravity of a child's layout parameters.

public View getZoomControls ()

Added in API level 4

Gets the view for the zoom controls.

Returns
  • The zoom controls view.

public boolean isAutoDismissed ()

Added in API level 4

Whether the zoom controls will be automatically dismissed after showing.

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

public boolean isVisible ()

Added in API level 4

Whether the zoom controls are visible to the user.

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

public void setAutoDismissed (boolean autoDismiss)

Added in API level 4

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

public void setFocusable (boolean focusable)

Added in API level 4

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 Whether the zoom controls should be focusable.

public void setOnZoomListener ( ZoomButtonsController.OnZoomListener listener)

Added in API level 4

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

Parameters
listener The listener that will be told to zoom.

public void setVisible (boolean visible)

Added in API level 4

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

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

public void setZoomInEnabled (boolean enabled)

Added in API level 4

Whether to enable the zoom in control.

Parameters
enabled Whether to enable the zoom in control.

public void setZoomOutEnabled (boolean enabled)

Added in API level 4

Whether to enable the zoom out control.

Parameters
enabled Whether to enable the zoom out control.

public void setZoomSpeed (long speed)

Added in API level 4

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

Parameters
speed The delay in milliseconds between zoom callbacks.