Android APIs
public class

MediaRouteButton

extends View
java.lang.Object
   ↳ android.view.View
     ↳ android.app.MediaRouteButton

Summary

[Expand]
Inherited XML Attributes
From class android.view.View
[Expand]
Inherited Constants
From class android.view.View
[Expand]
Inherited Fields
From class android.view.View
Public Constructors
MediaRouteButton(Context context)
MediaRouteButton(Context context, AttributeSet attrs)
MediaRouteButton(Context context, AttributeSet attrs, int defStyleAttr)
MediaRouteButton(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)
Public Methods
int getRouteTypes()
Gets the media route types for filtering the routes that the user can select using the media route chooser dialog.
void jumpDrawablesToCurrentState()
Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.
void onAttachedToWindow()
This is called when the view is attached to a window.
void onDetachedFromWindow()
This is called when the view is detached from a window.
boolean performClick()
Call this view's OnClickListener, if it is defined.
boolean performLongClick()
Call this view's OnLongClickListener, if it is defined.
void setExtendedSettingsClickListener(View.OnClickListener listener)
void setRouteTypes(int types)
Sets the types of routes that will be shown in the media route chooser dialog launched by this button.
void setVisibility(int visibility)
Set the enabled state of this view.
void showDialog()
Show the route chooser or controller dialog.
Protected Methods
void drawableStateChanged()
This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
int[] onCreateDrawableState(int extraSpace)
Generate the new Drawable state for this view.
void onDraw(Canvas canvas)
Implement this to do your drawing.
void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height.

boolean verifyDrawable(Drawable who)
If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.
[Expand]
Inherited Methods
From class android.view.View
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource

Public Constructors

public MediaRouteButton (Context context)

Added in API level 16

Parameters
context Context

public MediaRouteButton (Context context, AttributeSet attrs)

Added in API level 16

Parameters
context Context
attrs AttributeSet

public MediaRouteButton (Context context, AttributeSet attrs, int defStyleAttr)

Added in API level 16

Parameters
context Context
attrs AttributeSet
defStyleAttr int

public MediaRouteButton (Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Added in API level 21

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

Public Methods

public int getRouteTypes ()

Added in API level 16

Gets the media route types for filtering the routes that the user can select using the media route chooser dialog.

Returns
int The route types.

public void jumpDrawablesToCurrentState ()

Added in API level 16

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Also calls jumpToCurrentState() if there is a StateListAnimator attached to this view.

public void onAttachedToWindow ()

Added in API level 16

This is called when the view is attached to a window. At this point it has a Surface and will start drawing. Note that this function is guaranteed to be called before onDraw(android.graphics.Canvas), however it may be called any time before the first onDraw -- including before or after onMeasure(int, int).

public void onDetachedFromWindow ()

Added in API level 16

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

public boolean performClick ()

Added in API level 16

Call this view's OnClickListener, if it is defined. Performs all normal actions associated with clicking: reporting accessibility event, playing a sound, etc.

Returns
boolean True there was an assigned OnClickListener that was called, false otherwise is returned.

public boolean performLongClick ()

Added in API level 16

Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the OnLongClickListener did not consume the event.

Returns
boolean True if one of the above receivers consumed the event, false otherwise.

public void setExtendedSettingsClickListener (View.OnClickListener listener)

Added in API level 16

Parameters
listener View.OnClickListener

public void setRouteTypes (int types)

Added in API level 16

Sets the types of routes that will be shown in the media route chooser dialog launched by this button.

Parameters
types int: The route types to match.

public void setVisibility (int visibility)

Added in API level 16

Set the enabled state of this view.

Parameters
visibility int: One of VISIBLE, INVISIBLE, or GONE.

public void showDialog ()

Added in API level 16

Show the route chooser or controller dialog.

If the default route is selected or if the currently selected route does not match the route types, then shows the route chooser dialog. Otherwise, shows the route controller dialog to offer the user a choice to disconnect from the route or perform other control actions such as setting the route's volume.

This will attach a DialogFragment to the containing Activity.

Protected Methods

protected void drawableStateChanged ()

Added in API level 16

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

If the View has a StateListAnimator, it will also be called to run necessary state change animations.

Be sure to call through to the superclass when overriding this function.

protected int[] onCreateDrawableState (int extraSpace)

Added in API level 16

Generate the new Drawable state for this view. This is called by the view system when the cached Drawable state is determined to be invalid. To retrieve the current state, you should use getDrawableState().

Parameters
extraSpace int: if non-zero, this is the number of extra entries you would like in the returned array in which you can place your own states.
Returns
int[] Returns an array holding the current Drawable state of the view.

protected void onDraw (Canvas canvas)

Added in API level 16

Implement this to do your drawing.

Parameters
canvas Canvas: the canvas on which the background will be drawn

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Added in API level 16

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overridden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters
widthMeasureSpec int: horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec int: vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

protected boolean verifyDrawable (Drawable who)

Added in API level 16

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled.

Be sure to call through to the super class when overriding this function.

Parameters
who Drawable: The Drawable to verify. Return true if it is one you are displaying, else return the result of calling through to the super class.
Returns
boolean boolean If true than the Drawable is being displayed in the view; else false and it is not allowed to animate.