|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.unifiedsearch.action.UiAction
public abstract class UiAction
Allows a data source provider to determine the user interface (UI) elements that display when
a user selects a search result. UiAction provides a generic way for SearchableEntity
objects to present context-sensitive action choices to a search user.
A data source provider should implement UiAction for all actions relevant to the data,
then make those action objects available through the provider's Searchable and SearchableEntity
objects. An application that creates appointment data, for example, may want separate actions for
canceling an appointment, sending a reminder, and calling attendees.
| Constructor Summary | ||
|---|---|---|
|
UiAction()
Initializes a new UiAction. |
|
| Method Summary | ||
|---|---|---|
|
Image |
getIcon()
Returns the icon associated with this action. |
|
Object |
getSearchKeywords()
Returns the search keywords used to find the SearchableEntity
associated with this UiAction or null if none exist. |
|
SearchableEntity |
getSearchableEntity()
Returns the SearchableEntity associated with this UiAction or
null if none exists. |
|
void |
performAction(SearchableEntity consumed)
Provides a public wrapper for runAction(). |
|
protected abstract void |
runAction()
Defines application-specific behavior. |
|
void |
setEntryPointIndex(int index)
Set the application entry point index. |
|
void |
setSearchKeywords(Object searchKeywords)
Set the search keywords. |
|
String |
toString()
Returns the name for this action. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public UiAction()
UiAction.
| Method Detail |
|---|
public final void performAction(SearchableEntity consumed)
runAction(). Allows an application to prepare the
platform, the SearchableEntity submitted, or another part of the application for the
impending action. For example, an application could check for, or enforce, referential integrity
between data elements in this function.
consumed - The SearchableEntity that invoked the action.public SearchableEntity getSearchableEntity()
SearchableEntity associated with this UiAction or
null if none exists.
SearchableEntity object associated with this action.public Object getSearchKeywords()
SearchableEntity
associated with this UiAction or null if none exist.
String or String[].public void setSearchKeywords(Object searchKeywords)
searchKeywords - The search keywords object.protected abstract void runAction()
SearchableEntity represents a contact
displayed in a list, then selecting the contact should push an application screen that knows how
to display the details of the contact.
public String toString()
toString in class Objectpublic Image getIcon()
public void setEntryPointIndex(int index)
index - The index that corresponds to the order in which alternate entry points were created in
the original BlackBerry application project from 0. Applications can create one separate alternate entry point
for all the UI actions. This way applications can distinguish whether the application was launched
directly or whether the application was launched since the UI action was performed.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal