PointerIcon
public
final
class
PointerIcon
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.view.PointerIcon |
Represents an icon that can be used as a mouse pointer.
Pointer icons can be provided either by the system using system types, or by applications using bitmaps or application resources.
Summary
Constants | |
---|---|
int |
TYPE_ALIAS
Type constant: alias (indicating an alias of/shortcut to something is to be created. |
int |
TYPE_ALL_SCROLL
Type constant: all-scroll. |
int |
TYPE_ARROW
Type constant: Arrow icon. |
int |
TYPE_CELL
Type constant: cell. |
int |
TYPE_CONTEXT_MENU
Type constant: context-menu. |
int |
TYPE_COPY
Type constant: copy. |
int |
TYPE_CROSSHAIR
Type constant: crosshair. |
int |
TYPE_DEFAULT
The default pointer icon. |
int |
TYPE_GRAB
Type constant: grab. |
int |
TYPE_GRABBING
Type constant: grabbing. |
int |
TYPE_HAND
Type constant: hand. |
int |
TYPE_HELP
Type constant: help. |
int |
TYPE_HORIZONTAL_DOUBLE_ARROW
Type constant: horizontal double arrow mainly for resizing. |
int |
TYPE_NO_DROP
Type constant: no-drop. |
int |
TYPE_NULL
Type constant: Null icon. |
int |
TYPE_TEXT
Type constant: text. |
int |
TYPE_TOP_LEFT_DIAGONAL_DOUBLE_ARROW
Type constant: diagonal double arrow -- top-left to bottom-right. |
int |
TYPE_TOP_RIGHT_DIAGONAL_DOUBLE_ARROW
Type constant: diagonal double arrow -- top-right to bottom-left. |
int |
TYPE_VERTICAL_DOUBLE_ARROW
Type constant: vertical double arrow mainly for resizing. |
int |
TYPE_VERTICAL_TEXT
Type constant: vertical-text. |
int |
TYPE_WAIT
Type constant: wait. |
int |
TYPE_ZOOM_IN
Type constant: zoom-in. |
int |
TYPE_ZOOM_OUT
Type constant: zoom-out. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PointerIcon> |
CREATOR
|
Public methods | |
---|---|
static
PointerIcon
|
create(Bitmap bitmap, float hotSpotX, float hotSpotY)
Creates a custom pointer icon from the given bitmap and hotspot information. |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object other)
Indicates whether some other object is "equal to" this one. |
static
PointerIcon
|
getSystemIcon(Context context, int type)
Gets a system pointer icon for the given type. |
static
PointerIcon
|
load(Resources resources, int resourceId)
Loads a custom pointer icon from an XML resource. |
void
|
writeToParcel(Parcel out, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
TYPE_ALIAS
public static final int TYPE_ALIAS
Type constant: alias (indicating an alias of/shortcut to something is to be created.
Constant Value: 1010 (0x000003f2)
TYPE_ALL_SCROLL
public static final int TYPE_ALL_SCROLL
Type constant: all-scroll.
Constant Value: 1013 (0x000003f5)
TYPE_ARROW
public static final int TYPE_ARROW
Type constant: Arrow icon. (Default mouse pointer)
Constant Value: 1000 (0x000003e8)
TYPE_CELL
public static final int TYPE_CELL
Type constant: cell.
Constant Value: 1006 (0x000003ee)
TYPE_CONTEXT_MENU
public static final int TYPE_CONTEXT_MENU
Type constant: context-menu.
Constant Value: 1001 (0x000003e9)
TYPE_COPY
public static final int TYPE_COPY
Type constant: copy.
Constant Value: 1011 (0x000003f3)
TYPE_CROSSHAIR
public static final int TYPE_CROSSHAIR
Type constant: crosshair.
Constant Value: 1007 (0x000003ef)
TYPE_DEFAULT
public static final int TYPE_DEFAULT
The default pointer icon.
Constant Value: 1000 (0x000003e8)
TYPE_GRAB
public static final int TYPE_GRAB
Type constant: grab.
Constant Value: 1020 (0x000003fc)
TYPE_GRABBING
public static final int TYPE_GRABBING
Type constant: grabbing.
Constant Value: 1021 (0x000003fd)
TYPE_HAND
public static final int TYPE_HAND
Type constant: hand.
Constant Value: 1002 (0x000003ea)
TYPE_HELP
public static final int TYPE_HELP
Type constant: help.
Constant Value: 1003 (0x000003eb)
TYPE_HORIZONTAL_DOUBLE_ARROW
public static final int TYPE_HORIZONTAL_DOUBLE_ARROW
Type constant: horizontal double arrow mainly for resizing.
Constant Value: 1014 (0x000003f6)
TYPE_NO_DROP
public static final int TYPE_NO_DROP
Type constant: no-drop.
Constant Value: 1012 (0x000003f4)
TYPE_NULL
public static final int TYPE_NULL
Type constant: Null icon. It has no bitmap.
Constant Value: 0 (0x00000000)
TYPE_TEXT
public static final int TYPE_TEXT
Type constant: text.
Constant Value: 1008 (0x000003f0)
TYPE_TOP_LEFT_DIAGONAL_DOUBLE_ARROW
public static final int TYPE_TOP_LEFT_DIAGONAL_DOUBLE_ARROW
Type constant: diagonal double arrow -- top-left to bottom-right.
Constant Value: 1017 (0x000003f9)
TYPE_TOP_RIGHT_DIAGONAL_DOUBLE_ARROW
public static final int TYPE_TOP_RIGHT_DIAGONAL_DOUBLE_ARROW
Type constant: diagonal double arrow -- top-right to bottom-left.
Constant Value: 1016 (0x000003f8)
TYPE_VERTICAL_DOUBLE_ARROW
public static final int TYPE_VERTICAL_DOUBLE_ARROW
Type constant: vertical double arrow mainly for resizing.
Constant Value: 1015 (0x000003f7)
TYPE_VERTICAL_TEXT
public static final int TYPE_VERTICAL_TEXT
Type constant: vertical-text.
Constant Value: 1009 (0x000003f1)
TYPE_WAIT
public static final int TYPE_WAIT
Type constant: wait.
Constant Value: 1004 (0x000003ec)
TYPE_ZOOM_IN
public static final int TYPE_ZOOM_IN
Type constant: zoom-in.
Constant Value: 1018 (0x000003fa)
TYPE_ZOOM_OUT
public static final int TYPE_ZOOM_OUT
Type constant: zoom-out.
Constant Value: 1019 (0x000003fb)
Fields
Public methods
create
public static PointerIcon create (Bitmap bitmap, float hotSpotX, float hotSpotY)
Creates a custom pointer icon from the given bitmap and hotspot information.
Parameters | |
---|---|
bitmap |
Bitmap : The bitmap for the icon.This value must never be |
hotSpotX |
float : The X offset of the pointer icon hotspot in the bitmap.
Must be within the [0, bitmap.getWidth()) range. |
hotSpotY |
float : The Y offset of the pointer icon hotspot in the bitmap.
Must be within the [0, bitmap.getHeight()) range. |
Returns | |
---|---|
PointerIcon |
A pointer icon for this bitmap. |
Throws | |
---|---|
IllegalArgumentException |
if bitmap is null, or if the x/y hotspot parameters are invalid. |
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
equals
public boolean equals (Object other)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
other |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getSystemIcon
public static PointerIcon getSystemIcon (Context context, int type)
Gets a system pointer icon for the given type. If typeis not recognized, returns the default pointer icon.
Parameters | |
---|---|
context |
Context : The context.This value must never be |
type |
int : The pointer icon type. |
Returns | |
---|---|
PointerIcon |
The pointer icon. |
Throws | |
---|---|
IllegalArgumentException |
if context is null. |
load
public static PointerIcon load (Resources resources, int resourceId)
Loads a custom pointer icon from an XML resource.
The XML resource should have the following form:
<?xml version="1.0" encoding="utf-8"?>
<pointer-icon xmlns:android="http://schemas.android.com/apk/res/android"
android:bitmap="@drawable/my_pointer_bitmap"
android:hotSpotX="24"
android:hotSpotY="24" />
Parameters | |
---|---|
resources |
Resources : The resources object.This value must never be |
resourceId |
int : The resource id. |
Returns | |
---|---|
PointerIcon |
The pointer icon. |
Throws | |
---|---|
IllegalArgumentException |
if resources is null. |
|
if the resource was not found or the drawable linked in the resource was not found. |
writeToParcel
public void writeToParcel (Parcel out, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
out |
Parcel : The Parcel in which the object should be written. |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
|
Annotations
Interfaces
- ActionMode.Callback
- ActionProvider.VisibilityListener
- Choreographer.FrameCallback
- CollapsibleActionView
- ContextMenu
- ContextMenu.ContextMenuInfo
- GestureDetector.OnContextClickListener
- GestureDetector.OnDoubleTapListener
- GestureDetector.OnGestureListener
- InputQueue.Callback
- KeyEvent.Callback
- LayoutInflater.Factory
- LayoutInflater.Factory2
- LayoutInflater.Filter
- Menu
- MenuItem
- MenuItem.OnActionExpandListener
- MenuItem.OnMenuItemClickListener
- PixelCopy.OnPixelCopyFinishedListener
- ScaleGestureDetector.OnScaleGestureListener
- SubMenu
- SurfaceHolder
- SurfaceHolder.Callback
- SurfaceHolder.Callback2
- TextureView.SurfaceTextureListener
- View.OnApplyWindowInsetsListener
- View.OnAttachStateChangeListener
- View.OnCapturedPointerListener
- View.OnClickListener
- View.OnContextClickListener
- View.OnCreateContextMenuListener
- View.OnDragListener
- View.OnFocusChangeListener
- View.OnGenericMotionListener
- View.OnHoverListener
- View.OnKeyListener
- View.OnLayoutChangeListener
- View.OnLongClickListener
- View.OnScrollChangeListener
- View.OnSystemUiVisibilityChangeListener
- View.OnTouchListener
- View.OnUnhandledKeyEventListener
- ViewGroup.OnHierarchyChangeListener
- ViewManager
- ViewParent
- ViewStub.OnInflateListener
- ViewTreeObserver.OnDrawListener
- ViewTreeObserver.OnGlobalFocusChangeListener
- ViewTreeObserver.OnGlobalLayoutListener
- ViewTreeObserver.OnPreDrawListener
- ViewTreeObserver.OnScrollChangedListener
- ViewTreeObserver.OnTouchModeChangeListener
- ViewTreeObserver.OnWindowAttachListener
- ViewTreeObserver.OnWindowFocusChangeListener
- Window.Callback
- Window.OnFrameMetricsAvailableListener
- Window.OnRestrictedCaptionAreaChangedListener
- WindowManager
Classes
- AbsSavedState
- ActionMode
- ActionMode.Callback2
- ActionProvider
- Choreographer
- ContextThemeWrapper
- Display
- Display.HdrCapabilities
- Display.Mode
- DisplayCutout
- DragAndDropPermissions
- DragEvent
- FocusFinder
- FrameMetrics
- FrameStats
- GestureDetector
- GestureDetector.SimpleOnGestureListener
- Gravity
- HapticFeedbackConstants
- InputDevice
- InputDevice.MotionRange
- InputEvent
- InputQueue
- KeyboardShortcutGroup
- KeyboardShortcutInfo
- KeyCharacterMap
- KeyCharacterMap.KeyData
- KeyEvent
- KeyEvent.DispatcherState
- LayoutInflater
- MenuInflater
- MotionEvent
- MotionEvent.PointerCoords
- MotionEvent.PointerProperties
- OrientationEventListener
- OrientationListener
- PixelCopy
- PointerIcon
- ScaleGestureDetector
- ScaleGestureDetector.SimpleOnScaleGestureListener
- SearchEvent
- SoundEffectConstants
- Surface
- SurfaceView
- TextureView
- TouchDelegate
- VelocityTracker
- View
- View.AccessibilityDelegate
- View.BaseSavedState
- View.DragShadowBuilder
- View.MeasureSpec
- ViewAnimationUtils
- ViewConfiguration
- ViewDebug
- ViewGroup
- ViewGroup.LayoutParams
- ViewGroup.MarginLayoutParams
- ViewGroupOverlay
- ViewOutlineProvider
- ViewOverlay
- ViewPropertyAnimator
- ViewStructure
- ViewStructure.HtmlInfo
- ViewStructure.HtmlInfo.Builder
- ViewStub
- ViewTreeObserver
- Window
- WindowAnimationFrameStats
- WindowContentFrameStats
- WindowId
- WindowId.FocusObserver
- WindowInsets
- WindowManager.LayoutParams
Enums
Exceptions