public class

KeyboardView

extends View
implements View.OnClickListener

java.lang.Object
↳	android.view.View
	↳	android.inputmethodservice.KeyboardView

Class Overview

A view that renders a virtual Keyboard. It handles rendering of keys and detecting key presses and touch movements.

Summary

Nested Classes
public class	KeyboardView.OnKeyboardActionListener	Listener for virtual keyboard events.

XML Attributes
Attribute Name	Related Method	Description
android:keyBackground		Image for the key.
android:keyPreviewLayout		Layout resource for key press feedback.
android:keyPreviewOffset		Vertical offset of the key press feedback from the key.
android:keyTextColor		Color to use for the label in a key Must be a color value, in the form of "`#rgb`", "`#argb`", "`#rrggbb`", or "`#aarrggbb`".
android:keyTextSize		Size of the text for character keys.
android:labelTextSize		Size of the text for custom keys with some text and no icon.
android:popupLayout		Layout resource for popup keyboards Must be a reference to another resource, in the form "`@[+][package:]type:name`" or to a theme attribute in the form "`?[package:][type:]name`".
android:verticalCorrection		Amount to offset the touch Y coordinate by, for bias correction.

[Expand]

Inherited XML Attributes

From class android.view.View

[Expand]

Inherited Constants

From class android.view.View

Public Constructors
	KeyboardView(Context context, AttributeSet attrs)
	KeyboardView(Context context, AttributeSet attrs, int defStyle)

Public Methods
void	closing()
Keyboard	getKeyboard() Returns the current keyboard being displayed by this view.
boolean	handleBack()
boolean	isPreviewEnabled() Returns the enabled state of the key feedback popup.
boolean	isProximityCorrectionEnabled() Returns true if proximity correction is enabled.
boolean	isShifted() Returns the state of the shift key of the keyboard, if any.
void	onDetachedFromWindow() This is called when the view is detached from a window.
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.
void	onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
boolean	onTouchEvent(MotionEvent me) Implement this method to handle touch screen motion events.
void	setKeyboard(Keyboard keyboard) Attaches a keyboard to this view.
void	setOnKeyboardActionListener(KeyboardView.OnKeyboardActionListener listener)
void	setPopupOffset(int x, int y)
void	setPopupParent(View v)
void	setPreviewEnabled(boolean previewEnabled) Enables or disables the key feedback popup.
void	setProximityCorrectionEnabled(boolean enabled) When enabled, calls to onKey(int, int[]) will include key codes for adjacent keys.
boolean	setShifted(boolean shifted) Sets the state of the shift key of the keyboard, if any.
void	setVerticalCorrection(int verticalOffset)

Protected Methods
KeyboardView.OnKeyboardActionListener	getOnKeyboardActionListener() Returns the KeyboardView.OnKeyboardActionListener object.
boolean	onLongPress(Keyboard.Key popupKey) Called when a key is long pressed.
void	swipeDown()
void	swipeLeft()
void	swipeRight()
void	swipeUp()

[Expand]

Inherited Methods

From class android.view.View

void	addFocusables(ArrayList<View> views, int direction) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addTouchables(ArrayList<View> views) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.
void	bringToFront() Change the view's z order in the tree, so it's on top of other sibling views
void	buildDrawingCache() Forces the drawing cache to be built if the drawing cache is invalid.
void	cancelLongPress() Cancels a pending long press.
boolean	checkInputConnectionProxy(View view) Called by the InputMethodManager when a view who is not the current input connection target is trying to make a call on the manager.
void	clearAnimation() Cancels any animations for this view.
void	clearFocus() Called when this view wants to give up focus.
int	computeHorizontalScrollExtent() Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollOffset() Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents.
void	computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
int	computeVerticalScrollExtent() Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range.
int	computeVerticalScrollOffset() Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range.
int	computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents.
void	createContextMenu(ContextMenu menu) Show the context menu for this view.
void	destroyDrawingCache() Frees the resources used by the drawing cache.
void	dispatchDraw(Canvas canvas) Called by draw to draw the child views.
boolean	dispatchKeyEvent(KeyEvent event) Dispatch a key event to the next view on the focus path.
boolean	dispatchKeyEventPreIme(KeyEvent event) Dispatch a key event before it is processed by any input method associated with the view hierarchy.
boolean	dispatchKeyShortcutEvent(KeyEvent event) Dispatches a key shortcut event.
void	dispatchRestoreInstanceState(SparseArray<Parcelable> container) Called by restoreHierarchyState(SparseArray) to retrieve the state for this view and its children.
void	dispatchSaveInstanceState(SparseArray<Parcelable> container) Called by saveHierarchyState(SparseArray) to store the state for this view and its children.
void	dispatchSetPressed(boolean pressed) Dispatch setPressed to all of this View's children.
void	dispatchSetSelected(boolean selected) Dispatch setSelected to all of this View's children.
boolean	dispatchTouchEvent(MotionEvent event) Pass the touch screen motion event down to the target view, or this view if it is the target.
boolean	dispatchTrackballEvent(MotionEvent event) Pass a trackball motion event down to the focused view.
boolean	dispatchUnhandledMove(View focused, int direction) This method is the last chance for the focused view and its ancestors to respond to an arrow key.
void	dispatchWindowFocusChanged(boolean hasFocus) Called when the window containing this view gains or loses window focus.
void	dispatchWindowVisibilityChanged(int visibility) Dispatch a window visibility change down the view hierarchy.
void	draw(Canvas canvas) Manually render this view (and all of its children) to the given Canvas.
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.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
View	findFocus() Find the view in the hierarchy rooted at this view that currently has focus.
final View	findViewById(int id) Look for a child view with the given id.
final View	findViewWithTag(Object tag) Look for a child view with the given tag.
boolean	fitSystemWindows(Rect insets) Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag is set
View	focusSearch(int direction) Find the nearest view in the specified direction that can take focus.
void	forceLayout() Forces this view to be laid out during the next layout pass.
Animation	getAnimation() Get the animation currently associated with this view.
IBinder	getApplicationWindowToken() Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.
Drawable	getBackground() Gets the background drawable
int	getBaseline() Return the offset of the widget's text baseline from the widget's top boundary.
final int	getBottom() Bottom position of this view relative to its parent.
float	getBottomFadingEdgeStrength() Returns the strength, or intensity, of the bottom faded edge.
int	getBottomPaddingOffset() Amount by which to extend the bottom fading region.
final Context	getContext() Returns the context the view is running in, through which it can access the current theme, resources, etc.
ContextMenu.ContextMenuInfo	getContextMenuInfo() Views should implement this if they have extra information to associate with the context menu.
static int	getDefaultSize(int size, int measureSpec) Utility to return a default size.
final int[]	getDrawableState() Return an array of resource IDs of the drawable states representing the current state of the view.
Bitmap	getDrawingCache() Returns the bitmap in which this view drawing is cached.
int	getDrawingCacheBackgroundColor()
int	getDrawingCacheQuality() Returns the quality of the drawing cache.
void	getDrawingRect(Rect outRect) Return the visible drawing bounds of your view.
long	getDrawingTime() Return the time at which the drawing of the view hierarchy started.
ArrayList<View>	getFocusables(int direction) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.
void	getFocusedRect(Rect r) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
boolean	getGlobalVisibleRect(Rect r, Point globalOffset) If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.
final boolean	getGlobalVisibleRect(Rect r)
Handler	getHandler()
final int	getHeight() Return the height of your view.
void	getHitRect(Rect outRect) Hit rectangle in parent's coordinates
int	getHorizontalFadingEdgeLength() Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.
int	getHorizontalScrollbarHeight() Returns the height of the horizontal scrollbar.
int	getId() Returns this view's identifier.
boolean	getKeepScreenOn() Returns whether the screen should remain on, corresponding to the current value of KEEP_SCREEN_ON.
ViewGroup.LayoutParams	getLayoutParams() Get the LayoutParams associated with this view.
final int	getLeft() Left position of this view relative to its parent.
float	getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge.
int	getLeftPaddingOffset() Amount by which to extend the left fading region.
final boolean	getLocalVisibleRect(Rect r)
void	getLocationInWindow(int[] location) Computes the coordinates of this view in its window.
void	getLocationOnScreen(int[] location) Computes the coordinates of this view on the screen.
final int	getMeasuredHeight() The height of this view as measured in the most recent call to measure().
final int	getMeasuredWidth() The width of this view as measured in the most recent call to measure().
int	getNextFocusDownId()
int	getNextFocusLeftId()
int	getNextFocusRightId()
int	getNextFocusUpId()
View.OnFocusChangeListener	getOnFocusChangeListener() Returns the focus-change callback registered for this view.
int	getPaddingBottom() Returns the bottom padding of this view.
int	getPaddingLeft() Returns the left padding of this view.
int	getPaddingRight() Returns the right padding of this view.
int	getPaddingTop() Returns the top padding of this view.
final ViewParent	getParent() Gets the parent of this view.
Resources	getResources() Returns the resources associated with this view.
final int	getRight() Right position of this view relative to its parent.
float	getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge.
int	getRightPaddingOffset() Amount by which to extend the right fading region.
View	getRootView() Finds the topmost view in the current view hierarchy.
int	getScrollBarStyle() Returns the current scrollbar style.
final int	getScrollX() Return the scrolled left position of this view.
final int	getScrollY() Return the scrolled top position of this view.
int	getSolidColor() Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.
int	getSuggestedMinimumHeight() Returns the suggested minimum height that the view should use.
int	getSuggestedMinimumWidth() Returns the suggested minimum width that the view should use.
Object	getTag() Returns this view's tag.
final int	getTop() Top position of this view relative to its parent.
float	getTopFadingEdgeStrength() Returns the strength, or intensity, of the top faded edge.
int	getTopPaddingOffset() Amount by which to extend the top fading region.
TouchDelegate	getTouchDelegate() Gets the TouchDelegate for this View.
ArrayList<View>	getTouchables() Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.
int	getVerticalFadingEdgeLength() Returns the size of the vertical faded edges used to indicate that more content in this view is visible.
int	getVerticalScrollbarWidth() Returns the width of the vertical scrollbar.
ViewTreeObserver	getViewTreeObserver() Returns the ViewTreeObserver for this view's hierarchy.
int	getVisibility() Returns the visibility status for this view.
final int	getWidth() Return the width of the your view.
int	getWindowAttachCount()
IBinder	getWindowToken() Retrieve a unique token identifying the window this view is attached to.
int	getWindowVisibility() Returns the current visibility of the window this view is attached to (either GONE, INVISIBLE, or VISIBLE).
void	getWindowVisibleDisplayFrame(Rect outRect) Retrieve the overall visible display size in which the window this view is attached to has been positioned in.
boolean	hasFocus() Returns true if this view has focus iteself, or is the ancestor of the view that has focus.
boolean	hasFocusable() Returns true if this view is focusable or if it contains a reachable View for which hasFocusable() returns true.
boolean	hasWindowFocus() Returns true if this view is in a window that currently has window focus.
static View	inflate(Context context, int resource, ViewGroup root) Inflate a view from an XML resource.
void	initializeFadingEdge(TypedArray a) Initializes the fading edges from a given set of styled attributes.
void	initializeScrollbars(TypedArray a) Initializes the scrollbars from a given set of styled attributes.
void	invalidate(int l, int t, int r, int b) Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
void	invalidate() Invalidate the whole view.
void	invalidate(Rect dirty) Mark the the area defined by dirty as needing to be drawn.
void	invalidateDrawable(Drawable drawable) Invalidates the specified Drawable.
boolean	isClickable() Indicates whether this view reacts to click events or not.
boolean	isDrawingCacheEnabled() Indicates whether the drawing cache is enabled for this view.
boolean	isDuplicateParentStateEnabled() Indicates whether this duplicates its drawable state from its parent.
boolean	isEnabled() Returns the enabled status for this view.
final boolean	isFocusable() Returns whether this View is able to take focus.
final boolean	isFocusableInTouchMode() When a view is focusable, it may not want to take focus when in touch mode.
boolean	isFocused() Returns true if this view has focus
boolean	isHapticFeedbackEnabled()
boolean	isHorizontalFadingEdgeEnabled() Indicate whether the horizontal edges are faded when the view is scrolled horizontally.
boolean	isHorizontalScrollBarEnabled() Indicate whether the horizontal scrollbar should be drawn or not.
boolean	isInEditMode() Indicates whether this View is currently in edit mode.
boolean	isInTouchMode() Returns whether the device is currently in touch mode.
boolean	isLayoutRequested() Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.
boolean	isLongClickable() Indicates whether this view reacts to long click events or not.
boolean	isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.
boolean	isPressed() Indicates whether the view is currently in pressed state.
boolean	isSaveEnabled() Indicates whether this view will save its state (that is, whether its onSaveInstanceState() method will be called).
boolean	isSelected() Indicates the selection state of this view.
boolean	isShown() Returns the visibility of this view and all of its ancestors
boolean	isSoundEffectsEnabled()
boolean	isVerticalFadingEdgeEnabled() Indicate whether the vertical edges are faded when the view is scrolled horizontally.
boolean	isVerticalScrollBarEnabled() Indicate whether the vertical scrollbar should be drawn or not.
final void	layout(int l, int t, int r, int b) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism.
final void	measure(int widthMeasureSpec, int heightMeasureSpec) This is called to find out how big a view should be.
static int[]	mergeDrawableStates(int[] baseState, int[] additionalState) Merge your own state values in `additionalState` into the base state values `baseState` that were returned by onCreateDrawableState(int).
void	offsetLeftAndRight(int offset) Offset this view's horizontal location by the specified amount of pixels.
void	offsetTopAndBottom(int offset) Offset this view's vertical location by the specified number of pixels.
void	onAnimationEnd() Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view.
void	onAnimationStart() Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view.
void	onAttachedToWindow() This is called when the view is attached to a window.
boolean	onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.
void	onCreateContextMenu(ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu.
int[]	onCreateDrawableState(int extraSpace) Generate the new Drawable state for this view.
InputConnection	onCreateInputConnection(EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view.
void	onDetachedFromWindow() This is called when the view is detached from a window.
void	onDraw(Canvas canvas) Implement this to do your drawing.
void	onFinishInflate() Finalize inflating a view from XML.
void	onFinishTemporaryDetach() Called after onStartTemporaryDetach() when the container is done changing the view.
void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
boolean	onKeyDown(int keyCode, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyMultiple(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released, if the view is enabled and clickable.
boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).
boolean	onKeyPreIme(int keyCode, KeyEvent event) Handle a key event before it is processed by any input method associated with the view hierarchy.
boolean	onKeyShortcut(int keyCode, KeyEvent event) Called when an unhandled key shortcut event occurs.
boolean	onKeyUp(int keyCode, KeyEvent event) Default implementation of KeyEvent.Callback.onKeyMultiple(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released.
void	onLayout(boolean changed, int left, int top, int right, int bottom) Called from layout when this view should assign a size and position to each of its children.
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onScrollChanged(int l, int t, int oldl, int oldt) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).
boolean	onSetAlpha(int alpha) Invoked if there is a Transform that involves alpha.
void	onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
void	onStartTemporaryDetach() This is called when a container is going to temporarily detach a child that currently has focus, with ViewGroup.detachViewFromParent.
boolean	onTouchEvent(MotionEvent event) Implement this method to handle touch screen motion events.
boolean	onTrackballEvent(MotionEvent event) Implement this method to handle trackball motion events.
void	onWindowFocusChanged(boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
void	onWindowVisibilityChanged(int visibility) Called when the window containing has change its visibility (between GONE, INVISIBLE, and VISIBLE).
boolean	performClick() Call this view's OnClickListener, if it is defined.
boolean	performHapticFeedback(int feedbackConstant) BZZZTT!!1! Provide haptic feedback to the user for this view.
boolean	performHapticFeedback(int feedbackConstant, int flags) BZZZTT!!1! Like performHapticFeedback(int), with additional options.
boolean	performLongClick() Call this view's OnLongClickListener, if it is defined.
void	playSoundEffect(int soundConstant) Play a sound effect for this view.
boolean	post(Runnable action) Causes the Runnable to be added to the message queue.
boolean	postDelayed(Runnable action, long delayMillis) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses.
void	postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidate(int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds) Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds, int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	refreshDrawableState() Call this to force a view to update its drawable state.
boolean	removeCallbacks(Runnable action) Removes the specified Runnable from the message queue.
final boolean	requestFocus() Call this to try to give focus to a specific view or to one of its descendants.
boolean	requestFocus(int direction, Rect previouslyFocusedRect) Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from.
final boolean	requestFocus(int direction) Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading.
final boolean	requestFocusFromTouch() Call this to try to give focus to a specific view or to one of its descendants.
void	requestLayout() Call this when something has changed which has invalidated the layout of this view.
boolean	requestRectangleOnScreen(Rect rectangle, boolean immediate) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
boolean	requestRectangleOnScreen(Rect rectangle) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
static int	resolveSize(int size, int measureSpec) Utility to reconcile a desired size with constraints imposed by a MeasureSpec.
void	restoreHierarchyState(SparseArray<Parcelable> container) Restore this view hierarchy's frozen state from the given container.
void	saveHierarchyState(SparseArray<Parcelable> container) Store this view hierarchy's frozen state into the given container.
void	scheduleDrawable(Drawable who, Runnable what, long when) Schedules an action on a drawable to occur at a specified time.
void	scrollBy(int x, int y) Move the scrolled position of your view.
void	scrollTo(int x, int y) Set the scrolled position of your view.
void	setAnimation(Animation animation) Sets the next animation to play for this view.
void	setBackgroundColor(int color) Sets the background color for this view.
void	setBackgroundDrawable(Drawable d) Set the background to a given Drawable, or remove the background.
void	setBackgroundResource(int resid) Set the background to a given resource.
void	setClickable(boolean clickable) Enables or disables click events for this view.
void	setDrawingCacheBackgroundColor(int color) Setting a solid background color for the drawing cache's bitmaps will improve perfromance and memory usage.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setDrawingCacheQuality(int quality) Set the drawing cache quality of this view.
void	setDuplicateParentStateEnabled(boolean enabled) Enables or disables the duplication of the parent's state into this view.
void	setEnabled(boolean enabled) Set the enabled state of this view.
void	setFadingEdgeLength(int length) Set the size of the faded edge used to indicate that more content in this view is available.
void	setFocusable(boolean focusable) Set whether this view can receive the focus.
void	setFocusableInTouchMode(boolean focusableInTouchMode) Set whether this view can receive focus while in touch mode.
void	setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) Set whether this view should have haptic feedback for events such as long presses.
void	setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) Define whether the horizontal edges should be faded when this view is scrolled horizontally.
void	setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) Define whether the horizontal scrollbar should be drawn or not.
void	setId(int id) Sets the identifier for this view.
void	setKeepScreenOn(boolean keepScreenOn) Controls whether the screen should remain on, modifying the value of KEEP_SCREEN_ON.
void	setLayoutParams(ViewGroup.LayoutParams params) Set the layout parameters associated with this view.
void	setLongClickable(boolean longClickable) Enables or disables long click events for this view.
final void	setMeasuredDimension(int measuredWidth, int measuredHeight) This mehod must be called by onMeasure(int, int) to store the measured width and measured height.
void	setMinimumHeight(int minHeight) Sets the minimum height of the view.
void	setMinimumWidth(int minWidth) Sets the minimum width of the view.
void	setNextFocusDownId(int nextFocusDownId) Set the id of the view to use for the next focus
void	setNextFocusLeftId(int nextFocusLeftId) Set the id of the view to use for the next focus
void	setNextFocusRightId(int nextFocusRightId) Set the id of the view to use for the next focus
void	setNextFocusUpId(int nextFocusUpId) Set the id of the view to use for the next focus
void	setOnClickListener(View.OnClickListener l) Register a callback to be invoked when this view is clicked.
void	setOnCreateContextMenuListener(View.OnCreateContextMenuListener l) Register a callback to be invoked when the context menu for this view is being built.
void	setOnFocusChangeListener(View.OnFocusChangeListener l) Register a callback to be invoked when focus of this view changed.
void	setOnKeyListener(View.OnKeyListener l) Register a callback to be invoked when a key is pressed in this view.
void	setOnLongClickListener(View.OnLongClickListener l) Register a callback to be invoked when this view is clicked and held.
void	setOnTouchListener(View.OnTouchListener l) Register a callback to be invoked when a touch event is sent to this view.
void	setPadding(int left, int top, int right, int bottom) Sets the padding.
void	setPressed(boolean pressed) Sets the pressed that for this view.
void	setSaveEnabled(boolean enabled) Controls whether the saving of this view's state is enabled (that is, whether its onSaveInstanceState() method will be called).
void	setScrollBarStyle(int style) Specify the style of the scrollbars.
void	setScrollContainer(boolean isScrollContainer) Change whether this view is one of the set of scrollable containers in its window.
void	setSelected(boolean selected) Changes the selection state of this view.
void	setSoundEffectsEnabled(boolean soundEffectsEnabled) Set whether this view should have sound effects enabled for events such as clicking and touching.
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchDelegate(TouchDelegate delegate) Sets the TouchDelegate for this View.
void	setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) Define whether the vertical edges should be faded when this view is scrolled vertically.
void	setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) Define whether the vertical scrollbar should be drawn or not.
void	setVisibility(int visibility) Set the enabled state of this view.
void	setWillNotCacheDrawing(boolean willNotCacheDrawing) When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.
void	setWillNotDraw(boolean willNotDraw) If this view doesn't do any drawing on its own, set this flag to allow further optimizations.
boolean	showContextMenu() Bring up the context menu for this view.
void	startAnimation(Animation animation) Start the specified animation now.
void	unscheduleDrawable(Drawable who, Runnable what) Cancels a scheduled action on a drawable.
void	unscheduleDrawable(Drawable who) Unschedule any events associated with the given Drawable.
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.
boolean	willNotCacheDrawing() Returns whether or not this View can cache its drawing or not.
boolean	willNotDraw() Returns whether or not this View draws on its own.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface android.graphics.drawable.Drawable.Callback

From interface android.view.KeyEvent.Callback

From interface android.view.View.OnClickListener

XML Attributes

android:keyBackground

Image for the key. This image needs to be a StateListDrawable, with the following possible states: normal, pressed, checkable, checkable+pressed, checkable+checked, checkable+checked+pressed.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol keyBackground.

Related Methods

android:keyPreviewLayout

Layout resource for key press feedback.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol keyPreviewLayout.

Related Methods

android:keyPreviewOffset

Vertical offset of the key press feedback from the key.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol keyPreviewOffset.

Related Methods

android:keyTextColor

Color to use for the label in a key

Must be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol keyTextColor.

Related Methods

android:keyTextSize

Size of the text for character keys.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol keyTextSize.

Related Methods

android:labelTextSize

Size of the text for custom keys with some text and no icon.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol labelTextSize.

Related Methods

android:popupLayout

Layout resource for popup keyboards

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol popupLayout.

Related Methods

android:verticalCorrection

Amount to offset the touch Y coordinate by, for bias correction.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol verticalCorrection.

Related Methods

Public Constructors

public KeyboardView (Context context, AttributeSet attrs)

public KeyboardView (Context context, AttributeSet attrs, int defStyle)

Public Methods

public void closing ()

public Keyboard getKeyboard ()

Returns the current keyboard being displayed by this view.

Returns

the currently attached keyboard

public boolean handleBack ()

public boolean isPreviewEnabled ()

Returns the enabled state of the key feedback popup.

Returns

whether or not the key feedback popup is enabled

public boolean isProximityCorrectionEnabled ()

Returns true if proximity correction is enabled.

public boolean isShifted ()

Returns the state of the shift key of the keyboard, if any.

Returns

true if the shift is in a pressed state, false otherwise. If there is no shift key on the keyboard or there is no keyboard attached, it returns false.

public void onDetachedFromWindow ()

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

public void onDraw (Canvas canvas)

Implement this to do your drawing.

Parameters

canvas	the canvas on which the background will be drawn

public void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

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 overriden 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	horizontal space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.
heightMeasureSpec	vertical space requirements as imposed by the parent. The requirements are encoded with View.MeasureSpec.

public void onSizeChanged (int w, int h, int oldw, int oldh)

This is called during layout when the size of this view has changed. If you were just added to the view hierarchy, you're called with the old values of 0.

Parameters

w	Current width of this view.
h	Current height of this view.
oldw	Old width of this view.
oldh	Old height of this view.

public boolean onTouchEvent (MotionEvent me)

Implement this method to handle touch screen motion events.

Parameters

me	The motion event.

Returns

True if the event was handled, false otherwise.

public void setKeyboard (Keyboard keyboard)

Attaches a keyboard to this view. The keyboard can be switched at any time and the view will re-layout itself to accommodate the keyboard.

Parameters

keyboard	the keyboard to display in this view

public void setOnKeyboardActionListener (KeyboardView.OnKeyboardActionListener listener)

public void setPopupOffset (int x, int y)

public void setPopupParent (View v)

public void setPreviewEnabled (boolean previewEnabled)

Enables or disables the key feedback popup. This is a popup that shows a magnified version of the depressed key. By default the preview is enabled.

Parameters

previewEnabled	whether or not to enable the key feedback popup

public void setProximityCorrectionEnabled (boolean enabled)

When enabled, calls to onKey(int, int[]) will include key codes for adjacent keys. When disabled, only the primary key code will be reported.

Parameters

enabled	whether or not the proximity correction is enabled

public boolean setShifted (boolean shifted)

Sets the state of the shift key of the keyboard, if any.

Parameters

shifted	whether or not to enable the state of the shift key

Returns

true if the shift key state changed, false if there was no change

public void setVerticalCorrection (int verticalOffset)

Protected Methods

protected KeyboardView.OnKeyboardActionListener getOnKeyboardActionListener ()

Returns the KeyboardView.OnKeyboardActionListener object.

Returns

the listener attached to this keyboard

protected boolean onLongPress (Keyboard.Key popupKey)

Called when a key is long pressed. By default this will open any popup keyboard associated with this key through the attributes popupLayout and popupCharacters.

Parameters

popupKey	the key that was long pressed

Returns

true if the long press is handled, false otherwise. Subclasses should call the method on the base class if the subclass doesn't wish to handle the call.

Interfaces

Classes

KeyboardView

Class Overview

Summary

XML Attributes

android:keyBackground

Related Methods

android:keyPreviewLayout

Related Methods

android:keyPreviewOffset

Related Methods

android:keyTextColor

Related Methods

android:keyTextSize

Related Methods

android:labelTextSize

Related Methods

android:popupLayout

Related Methods

android:verticalCorrection

Related Methods

Public Constructors

public KeyboardView (Context context, AttributeSet attrs)

public KeyboardView (Context context, AttributeSet attrs, int defStyle)

Public Methods

public void closing ()

public Keyboard getKeyboard ()

Returns

See Also

public boolean handleBack ()

public boolean isPreviewEnabled ()

Returns

See Also

public boolean isProximityCorrectionEnabled ()

public boolean isShifted ()

Returns

See Also

public void onDetachedFromWindow ()

public void onDraw (Canvas canvas)

Parameters

public void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Parameters

public void onSizeChanged (int w, int h, int oldw, int oldh)

Parameters

public boolean onTouchEvent (MotionEvent me)

Parameters

Returns

public void setKeyboard (Keyboard keyboard)

Parameters

See Also

public void setOnKeyboardActionListener (KeyboardView.OnKeyboardActionListener listener)

public void setPopupOffset (int x, int y)

public void setPopupParent (View v)

public void setPreviewEnabled (boolean previewEnabled)

Parameters

See Also

public void setProximityCorrectionEnabled (boolean enabled)

Parameters

public boolean setShifted (boolean shifted)

Parameters

Returns

See Also

public void setVerticalCorrection (int verticalOffset)

Protected Methods

protected KeyboardView.OnKeyboardActionListener getOnKeyboardActionListener ()

Returns

protected boolean onLongPress (Keyboard.Key popupKey)

Parameters

Returns

protected void swipeDown ()

protected void swipeLeft ()

protected void swipeRight ()

protected void swipeUp ()