android.view
Interface Window.Callback

All Known Implementing Classes:

Activity, ActivityGroup, AlertDialog, AliasActivity, CharacterPickerDialog, DatePickerDialog, Dialog, ExpandableListActivity, LauncherActivity, ListActivity, PreferenceActivity, ProgressDialog, SearchDialog, TabActivity, TestBrowserActivity, TestListActivity, TimePickerDialog

Enclosing class:

Window

public static interface Window.Callback

API from a Window back to its caller. This allows the client to intercept key dispatching, panels and menus, etc.

Method Summary

boolean	dispatchKeyEvent(KeyEvent event) Called to process key events.
boolean	dispatchTouchEvent(MotionEvent event) Called to process touch screen events.
boolean	dispatchTrackballEvent(MotionEvent event) Called to process trackball events.
void	onContentChanged() This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).
boolean	onCreatePanelMenu(int featureId, Menu menu) Initialize the contents of the menu for panel 'featureId'.
View	onCreatePanelView(int featureId) Instantiate the view to display in the panel for 'featureId'.
boolean	onMenuItemSelected(int featureId, MenuItem item) Called when a panel's menu item has been selected by the user.
boolean	onMenuOpened(int featureId, Menu menu) Called when a panel's menu is opened by the user.
void	onPanelClosed(int featureId, Menu menu) Called when a panel is being closed.
boolean	onPreparePanel(int featureId, View view, Menu menu) Prepare a panel to be displayed.
boolean	onSearchRequested() Called when the user signals the desire to start a search.
void	onWindowAttributesChanged(WindowManager.LayoutParams attrs) This is called whenever the current window attributes change.
void	onWindowFocusChanged(boolean hasFocus) This hook is called whenever the window focus changes.

Method Detail

dispatchKeyEvent

boolean dispatchKeyEvent(KeyEvent event)

Called to process key events. At the very least your implementation must call Window.superDispatchKeyEvent(android.view.KeyEvent) to do the standard key processing.

Parameters:

event - The key event.

Returns:

boolean Return true if this event was consumed.

dispatchTouchEvent

boolean dispatchTouchEvent(MotionEvent event)

Called to process touch screen events. At the very least your implementation must call Window.superDispatchTouchEvent(android.view.MotionEvent) to do the standard touch screen processing.

Parameters:

event - The touch screen event.

Returns:

boolean Return true if this event was consumed.

dispatchTrackballEvent

boolean dispatchTrackballEvent(MotionEvent event)

Called to process trackball events. At the very least your implementation must call Window.superDispatchTrackballEvent(android.view.MotionEvent) to do the standard trackball processing.

Parameters:

event - The trackball event.

Returns:

boolean Return true if this event was consumed.

onCreatePanelView

View onCreatePanelView(int featureId)

Instantiate the view to display in the panel for 'featureId'. You can return null, in which case the default content (typically a menu) will be created for you.

Parameters:

featureId - Which panel is being created.

Returns:

view The top-level view to place in the panel.

See Also:

onPreparePanel(int, android.view.View, android.view.Menu)

onCreatePanelMenu

boolean onCreatePanelMenu(int featureId,
                          Menu menu)

Initialize the contents of the menu for panel 'featureId'. This is called if onCreatePanelView() returns null, giving you a standard menu in which you can place your items. It is only called once for the panel, the first time it is shown.

You can safely hold on to menu (and any items created from it), making modifications to it as desired, until the next time onCreatePanelMenu() is called for this feature.

Parameters:

featureId - The panel being created.

menu - The menu inside the panel.

Returns:

boolean You must return true for the panel to be displayed; if you return false it will not be shown.

onPreparePanel

boolean onPreparePanel(int featureId,
                       View view,
                       Menu menu)

Prepare a panel to be displayed. This is called right before the panel window is shown, every time it is shown.

Parameters:

featureId - The panel that is being displayed.

view - The View that was returned by onCreatePanelView().

menu - If onCreatePanelView() returned null, this is the Menu being displayed in the panel.

Returns:

boolean You must return true for the panel to be displayed; if you return false it will not be shown.

See Also:

onCreatePanelView(int)

onMenuOpened

boolean onMenuOpened(int featureId,
                     Menu menu)

Called when a panel's menu is opened by the user. This may also be called when the menu is changing from one type to another (for example, from the icon menu to the expanded menu).

Parameters:

featureId - The panel that the menu is in.

menu - The menu that is opened.

Returns:

Return true to allow the menu to open, or false to prevent the menu from opening.

onMenuItemSelected

boolean onMenuItemSelected(int featureId,
                           MenuItem item)

Called when a panel's menu item has been selected by the user.

Parameters:

featureId - The panel that the menu is in.

item - The menu item that was selected.

Returns:

boolean Return true to finish processing of selection, or false to perform the normal menu handling (calling its Runnable or sending a Message to its target Handler).

onWindowAttributesChanged

void onWindowAttributesChanged(WindowManager.LayoutParams attrs)

This is called whenever the current window attributes change.

onContentChanged

void onContentChanged()

This hook is called whenever the content view of the screen changes (due to a call to Window.setContentView or Window.addContentView).

onWindowFocusChanged

void onWindowFocusChanged(boolean hasFocus)

This hook is called whenever the window focus changes.

Parameters:

hasFocus - Whether the window now has focus.

onPanelClosed

void onPanelClosed(int featureId,
                   Menu menu)

Called when a panel is being closed. If another logical subsequent panel is being opened (and this panel is being closed to make room for the subsequent panel), this method will NOT be called.

Parameters:

featureId - The panel that is being displayed.

menu - If onCreatePanelView() returned null, this is the Menu being displayed in the panel.

onSearchRequested

boolean onSearchRequested()

Called when the user signals the desire to start a search.

Returns:

true if search launched, false if activity refuses (blocks)

See Also:

Activity.onSearchRequested()