com.google.appinventor.components.runtime

Class Form

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.view.ContextThemeWrapper

android.app.Activity

com.google.appinventor.components.runtime.Form

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2, android.view.KeyEvent.Callback, android.view.LayoutInflater.Factory, android.view.LayoutInflater.Factory2, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback, Component, ComponentContainer, HandlesEventDispatching

Direct Known Subclasses:

ReplForm

public class Form
extends android.app.Activity
implements Component, ComponentContainer, HandlesEventDispatching

Component underlying activities and UI apps, not directly accessible to Simple programmers.

This is the root container of any Android activity and also the superclass for for Simple/Android UI applications. The main form is always named "Screen1".

Field Summary

Fields

Modifier and Type	Field and Description
protected static Form	activeForm
static java.lang.String	APPINVENTOR_URL_SCHEME
protected java.lang.String	formName
protected java.lang.String	startupValue

Fields inherited from class android.app.Activity

DEFAULT_KEYS_DIALER, DEFAULT_KEYS_DISABLE, DEFAULT_KEYS_SEARCH_GLOBAL, DEFAULT_KEYS_SEARCH_LOCAL, DEFAULT_KEYS_SHORTCUT, FOCUSED_STATE_SET, RESULT_CANCELED, RESULT_FIRST_USER, RESULT_OK

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, AUDIO_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, CLIPBOARD_SERVICE, CONNECTIVITY_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, KEYGUARD_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_ROUTER_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, STORAGE_SERVICE, TELEPHONY_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, UI_MODE_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_P2P_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
Form()

Method Summary

Methods

Modifier and Type	Method and Description
void	$add(AndroidViewComponent component) Adds a component to a container.
android.app.Activity	$context() Returns the activity context (which can be retrieved from the root container - aka the form).
protected void	$define() Compiler-generated method to initialize and add application components to the form.
Form	$form() Returns the form that ultimately contains this container.
java.lang.String	AboutScreen() AboutScreen property getter method.
void	AboutScreen(java.lang.String aboutScreen) AboutScreen property setter method: sets a new aboutApp string for the form in the form's "About this application" menu.
void	addAboutInfoToMenu(android.view.Menu menu)
void	addExitButtonToMenu(android.view.Menu menu)
int	AlignHorizontal() Returns a number that encodes how contents of the screen are aligned horizontally.
void	AlignHorizontal(int alignment) Sets the horizontal alignment for contents of the screen
int	AlignVertical() Returns a number that encodes how contents of the arrangement are aligned vertically.
void	AlignVertical(int alignment) Sets the vertical alignment for contents of the screen
void	AppName(java.lang.String aName) Specifies the App Name.
int	BackgroundColor() BackgroundColor property getter method.
void	BackgroundColor(int argb) BackgroundColor property setter method.
java.lang.String	BackgroundImage() Returns the path of the background image.
void	BackgroundImage(java.lang.String path) Specifies the path of the background image.
boolean	BackPressed()
void	callInitialize(java.lang.Object component)
boolean	canDispatchEvent(Component component, java.lang.String eventName)
void	clear()
protected void	closeApplicationFromBlocks()
protected void	closeForm(android.content.Intent resultIntent)
java.lang.String	CloseScreenAnimation() Returns the type of close screen animation (default, fade, zoom, slidehorizontal, slidevertical and none).
void	CloseScreenAnimation(java.lang.String animType) Sets the animation type for the transition of this form closing and returning to a form behind it in the activity stack.
void	deleteComponent(java.lang.Object component)
void	dispatchErrorOccurredEvent(Component component, java.lang.String functionName, int errorNumber, java.lang.Object... messageArgs)
void	dispatchErrorOccurredEventDialog(Component component, java.lang.String functionName, int errorNumber, java.lang.Object... messageArgs)
boolean	dispatchEvent(Component component, java.lang.String componentName, java.lang.String eventName, java.lang.Object[] args) A trivial implementation to artificially make this class concrete so that it is included in the documentation and Codeblocks language definition file generated by com.google.appinventor.components.scripts.DocumentationGenerator and com.google.appinventor.components.scripts.LangDefXmlGenerator, respectively.
void	dontGrabTouchEventsForComponent()
void	ErrorOccurred(Component component, java.lang.String functionName, int errorNumber, java.lang.String message) ErrorOccurred event handler.
void	ErrorOccurredDialog(Component component, java.lang.String functionName, int errorNumber, java.lang.String message, java.lang.String title, java.lang.String buttonText)
static void	finishActivity() Closes the current screen, as opposed to finishApplication, which exits the entire application.
static void	finishActivityWithResult(java.lang.Object result)
static void	finishActivityWithTextResult(java.lang.String result)
static void	finishApplication()
android.os.Bundle	fullScreenVideoAction(int action, VideoPlayer source, java.lang.Object data) Perform some action related to fullscreen video display.
static Form	getActiveForm()
HandlesEventDispatching	getDispatchDelegate() Returns the dispatch delegate that is responsible for dispatching events for this component.
java.lang.String	getOpenAnimType()
static java.lang.String	getStartText() Returns the string that was passed to this screen when it was opened
static java.lang.Object	getStartValue() Returns the value that was passed to this screen when it was opened
int	Height() Height property getter method.
void	Icon(java.lang.String name) Specifies the name of the application icon.
void	Initialize() Initialize event handler.
protected static java.lang.String	jsonEncodeForForm(java.lang.Object value, java.lang.String functionName)
protected void	onActivityResult(int requestCode, int resultCode, android.content.Intent data)
void	onConfigurationChanged(android.content.res.Configuration newConfig)
void	onCreate(android.os.Bundle icicle)
android.app.Dialog	onCreateDialog(int id)
boolean	onCreateOptionsMenu(android.view.Menu menu)
protected void	onDestroy()
boolean	onKeyDown(int keyCode, android.view.KeyEvent event)
protected void	onNewIntent(android.content.Intent intent)
protected void	onPause()
void	onPrepareDialog(int id, android.app.Dialog dialog)
protected void	onResume()
protected void	onStop()
java.lang.String	OpenScreenAnimation() Returns the type of open screen animation (default, fade, zoom, slidehorizontal, slidevertical and none).
void	OpenScreenAnimation(java.lang.String animType) Sets the animation type for the transition to another screen.
void	OtherScreenClosed(java.lang.String otherScreenName, java.lang.Object result)
int	registerForActivityResult(ActivityResultListener listener)
void	registerForOnDestroy(OnDestroyListener component)
void	registerForOnInitialize(OnInitializeListener component) An app can register to be notified when App Inventor's Initialize block has fired.
void	registerForOnNewIntent(OnNewIntentListener component)
void	registerForOnPause(OnPauseListener component)
void	registerForOnResume(OnResumeListener component)
void	registerForOnStop(OnStopListener component)
java.lang.String	ScreenOrientation() The requested screen orientation.
void	ScreenOrientation(java.lang.String screenOrientation) ScreenOrientation property setter method: sets the screen orientation for the form.
void	ScreenOrientationChanged()
boolean	Scrollable() Scrollable property getter method.
void	Scrollable(boolean scrollable) Scrollable property setter method.
void	setChildHeight(AndroidViewComponent component, int height)
void	setChildWidth(AndroidViewComponent component, int width)
protected void	startNewForm(java.lang.String nextFormName, java.lang.Object startupValue)
static void	switchForm(java.lang.String nextFormName) Display a new form.
static void	switchFormWithStartValue(java.lang.String nextFormName, java.lang.Object startValue) Display a new form and pass a startup value to the new form.
java.lang.String	Title() Title property getter method.
void	Title(java.lang.String title) Title property setter method: sets a new caption for the form in the form's title bar.
protected boolean	toastAllowed()
void	unregisterForActivityResult(ActivityResultListener listener)
void	VersionCode(int vCode) Specifies the Version Code.
void	VersionName(java.lang.String vName) Specifies the Version Name.
int	Width() Width property getter method.

Methods inherited from class android.app.Activity

addContentView, closeContextMenu, closeOptionsMenu, createPendingResult, dismissDialog, dispatchGenericMotionEvent, dispatchKeyEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, dump, findViewById, finish, finishActivity, finishActivityFromChild, finishAffinity, finishFromChild, getActionBar, getApplication, getCallingActivity, getCallingPackage, getChangingConfigurations, getComponentName, getCurrentFocus, getFragmentManager, getIntent, getLastNonConfigurationInstance, getLayoutInflater, getLoaderManager, getLocalClassName, getMenuInflater, getParent, getParentActivityIntent, getPreferences, getRequestedOrientation, getSystemService, getTaskId, getTitle, getTitleColor, getVolumeControlStream, getWindow, getWindowManager, hasWindowFocus, invalidateOptionsMenu, isChangingConfigurations, isChild, isDestroyed, isFinishing, isTaskRoot, managedQuery, moveTaskToBack, navigateUpTo, navigateUpToFromChild, onActionModeFinished, onActionModeStarted, onApplyThemeResource, onAttachedToWindow, onAttachFragment, onBackPressed, onChildTitleChanged, onContentChanged, onContextItemSelected, onContextMenuClosed, onCreateContextMenu, onCreateDescription, onCreateDialog, onCreateNavigateUpTaskStack, onCreatePanelMenu, onCreatePanelView, onCreateThumbnail, onCreateView, onCreateView, onDetachedFromWindow, onGenericMotionEvent, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onLowMemory, onMenuItemSelected, onMenuOpened, onNavigateUp, onNavigateUpFromChild, onOptionsItemSelected, onOptionsMenuClosed, onPanelClosed, onPostCreate, onPostResume, onPrepareDialog, onPrepareNavigateUpTaskStack, onPrepareOptionsMenu, onPreparePanel, onRestart, onRestoreInstanceState, onRetainNonConfigurationInstance, onSaveInstanceState, onSearchRequested, onStart, onTitleChanged, onTouchEvent, onTrackballEvent, onTrimMemory, onUserInteraction, onUserLeaveHint, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, openContextMenu, openOptionsMenu, overridePendingTransition, recreate, registerForContextMenu, removeDialog, requestWindowFeature, runOnUiThread, setContentView, setContentView, setContentView, setDefaultKeyMode, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setFinishOnTouchOutside, setIntent, setProgress, setProgressBarIndeterminate, setProgressBarIndeterminateVisibility, setProgressBarVisibility, setRequestedOrientation, setResult, setResult, setSecondaryProgress, setTitle, setTitle, setTitleColor, setVisible, setVolumeControlStream, shouldUpRecreateTask, showDialog, showDialog, startActionMode, startActivities, startActivities, startActivity, startActivity, startActivityForResult, startActivityForResult, startActivityFromChild, startActivityFromChild, startActivityFromFragment, startActivityFromFragment, startActivityIfNeeded, startActivityIfNeeded, startIntentSender, startIntentSender, startIntentSenderForResult, startIntentSenderForResult, startIntentSenderFromChild, startIntentSenderFromChild, startManagingCursor, startNextMatchingActivity, startNextMatchingActivity, startSearch, stopManagingCursor, takeKeyEvents, triggerSearch, unregisterForContextMenu

Methods inherited from class android.view.ContextThemeWrapper

applyOverrideConfiguration, attachBaseContext, getResources, getTheme, setTheme

Methods inherited from class android.content.ContextWrapper

bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getContentResolver, getDatabasePath, getDir, getExternalCacheDir, getExternalFilesDir, getFilesDir, getFileStreamPath, getMainLooper, getObbDir, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getSharedPreferences, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isRestricted, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setWallpaper, setWallpaper, startInstrumentation, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getString, getString, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPINVENTOR_URL_SCHEME

public static final java.lang.String APPINVENTOR_URL_SCHEME

See Also:

Constant Field Values

activeForm

protected static Form activeForm

formName

protected java.lang.String formName

startupValue

protected java.lang.String startupValue

Constructor Detail

Form

public Form()

Method Detail

onCreate

public void onCreate(android.os.Bundle icicle)

Overrides:

onCreate in class android.app.Activity

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration newConfig)

Specified by:

onConfigurationChanged in interface android.content.ComponentCallbacks

Overrides:

onConfigurationChanged in class android.app.Activity

onKeyDown

public boolean onKeyDown(int keyCode,
                android.view.KeyEvent event)

Specified by:

onKeyDown in interface android.view.KeyEvent.Callback

Overrides:

onKeyDown in class android.app.Activity

BackPressed

public boolean BackPressed()

onActivityResult

protected void onActivityResult(int requestCode,
                    int resultCode,
                    android.content.Intent data)

Overrides:

onActivityResult in class android.app.Activity

registerForActivityResult

public int registerForActivityResult(ActivityResultListener listener)

unregisterForActivityResult

public void unregisterForActivityResult(ActivityResultListener listener)

onResume

protected void onResume()

Overrides:

onResume in class android.app.Activity

registerForOnResume

public void registerForOnResume(OnResumeListener component)

registerForOnInitialize

public void registerForOnInitialize(OnInitializeListener component)

An app can register to be notified when App Inventor's Initialize block has fired. They will be called in Initialize().

Parameters:

component -

onNewIntent

protected void onNewIntent(android.content.Intent intent)

Overrides:

onNewIntent in class android.app.Activity

registerForOnNewIntent

public void registerForOnNewIntent(OnNewIntentListener component)

onPause

protected void onPause()

Overrides:

onPause in class android.app.Activity

registerForOnPause

public void registerForOnPause(OnPauseListener component)

onStop

protected void onStop()

Overrides:

onStop in class android.app.Activity

registerForOnStop

public void registerForOnStop(OnStopListener component)

onDestroy

protected void onDestroy()

Overrides:

onDestroy in class android.app.Activity

registerForOnDestroy

public void registerForOnDestroy(OnDestroyListener component)

onCreateDialog

public android.app.Dialog onCreateDialog(int id)

Overrides:

onCreateDialog in class android.app.Activity

onPrepareDialog

public void onPrepareDialog(int id,
                   android.app.Dialog dialog)

Overrides:

onPrepareDialog in class android.app.Activity

$define

protected void $define()

Compiler-generated method to initialize and add application components to the form. We just provide an implementation here to artificially make this class concrete so that it is included in the documentation and Codeblocks language definition file generated by com.google.appinventor.components.scripts.DocumentationGenerator and com.google.appinventor.components.scripts.LangDefXmlGenerator, respectively. The actual implementation appears in runtime.scm.

canDispatchEvent

public boolean canDispatchEvent(Component component,
                       java.lang.String eventName)

Specified by:

canDispatchEvent in interface HandlesEventDispatching

dispatchEvent

public boolean dispatchEvent(Component component,
                    java.lang.String componentName,
                    java.lang.String eventName,
                    java.lang.Object[] args)

A trivial implementation to artificially make this class concrete so that it is included in the documentation and Codeblocks language definition file generated by com.google.appinventor.components.scripts.DocumentationGenerator and com.google.appinventor.components.scripts.LangDefXmlGenerator, respectively. The actual implementation appears in runtime.scm.

Specified by:

dispatchEvent in interface HandlesEventDispatching

Initialize

public void Initialize()

Initialize event handler.

ScreenOrientationChanged

public void ScreenOrientationChanged()

ErrorOccurred

public void ErrorOccurred(Component component,
                 java.lang.String functionName,
                 int errorNumber,
                 java.lang.String message)

ErrorOccurred event handler.

ErrorOccurredDialog

public void ErrorOccurredDialog(Component component,
                       java.lang.String functionName,
                       int errorNumber,
                       java.lang.String message,
                       java.lang.String title,
                       java.lang.String buttonText)

dispatchErrorOccurredEvent

public void dispatchErrorOccurredEvent(Component component,
                              java.lang.String functionName,
                              int errorNumber,
                              java.lang.Object... messageArgs)

dispatchErrorOccurredEventDialog

public void dispatchErrorOccurredEventDialog(Component component,
                                    java.lang.String functionName,
                                    int errorNumber,
                                    java.lang.Object... messageArgs)

Scrollable

public boolean Scrollable()

Scrollable property getter method.

Returns:

true if the screen is vertically scrollable

Scrollable

public void Scrollable(boolean scrollable)

Scrollable property setter method.

Parameters:

scrollable - true if the screen should be vertically scrollable

BackgroundColor

public int BackgroundColor()

BackgroundColor property getter method.

Returns:

background RGB color with alpha

BackgroundColor

public void BackgroundColor(int argb)

BackgroundColor property setter method.

Parameters:

argb - background RGB color with alpha

BackgroundImage

public java.lang.String BackgroundImage()

Returns the path of the background image.

Returns:

the path of the background image

BackgroundImage

public void BackgroundImage(java.lang.String path)

Specifies the path of the background image.

See MediaUtil.determineMediaSource(com.google.appinventor.components.runtime.Form, java.lang.String) for information about what a path can be.

Parameters:

path - the path of the background image

Title

public java.lang.String Title()

Title property getter method.

Returns:

form caption

Title

public void Title(java.lang.String title)

Title property setter method: sets a new caption for the form in the form's title bar.

Parameters:

title - new form caption

AboutScreen

public java.lang.String AboutScreen()

AboutScreen property getter method.

Returns:

AboutScreen string

AboutScreen

public void AboutScreen(java.lang.String aboutScreen)

AboutScreen property setter method: sets a new aboutApp string for the form in the form's "About this application" menu.

Parameters:

title - new form caption

ScreenOrientation

public java.lang.String ScreenOrientation()

The requested screen orientation. Commonly used values are unspecified (-1), landscape (0), portrait (1), sensor (4), and user (2). " + "See the Android developer documentation for ActivityInfo.Screen_Orientation for the " + "complete list of possible settings. ScreenOrientation property getter method.

Returns:

screen orientation

ScreenOrientation

public void ScreenOrientation(java.lang.String screenOrientation)

ScreenOrientation property setter method: sets the screen orientation for the form.

Parameters:

screenOrientation - the screen orientation as a string

AlignHorizontal

public int AlignHorizontal()

Returns a number that encodes how contents of the screen are aligned horizontally. The choices are: 1 = left aligned, 2 = horizontally centered, 3 = right aligned

AlignHorizontal

public void AlignHorizontal(int alignment)

Sets the horizontal alignment for contents of the screen

Parameters:

alignment -

AlignVertical

public int AlignVertical()

Returns a number that encodes how contents of the arrangement are aligned vertically. The choices are: 1 = top, 2 = vertically centered, 3 = aligned at the bottom. Vertical alignment has no effect if the screen is scrollable.

AlignVertical

public void AlignVertical(int alignment)

Sets the vertical alignment for contents of the screen

Parameters:

alignment -

OpenScreenAnimation

public java.lang.String OpenScreenAnimation()

Returns the type of open screen animation (default, fade, zoom, slidehorizontal, slidevertical and none).

Returns:

open screen animation

OpenScreenAnimation

public void OpenScreenAnimation(java.lang.String animType)

Sets the animation type for the transition to another screen.

Parameters:

animType - the type of animation to use for the transition

CloseScreenAnimation

public java.lang.String CloseScreenAnimation()

Returns the type of close screen animation (default, fade, zoom, slidehorizontal, slidevertical and none).

Returns:

open screen animation

CloseScreenAnimation

public void CloseScreenAnimation(java.lang.String animType)

Sets the animation type for the transition of this form closing and returning to a form behind it in the activity stack.

Parameters:

animType - the type of animation to use for the transition

getOpenAnimType

public java.lang.String getOpenAnimType()

Icon

public void Icon(java.lang.String name)

Specifies the name of the application icon.

Parameters:

name - the name of the application icon

VersionCode

public void VersionCode(int vCode)

Specifies the Version Code.

Parameters:

vCode - the version name of the application

VersionName

public void VersionName(java.lang.String vName)

Specifies the Version Name.

Parameters:

vName - the version name of the application

AppName

public void AppName(java.lang.String aName)

Specifies the App Name.

Parameters:

aName - the display name of the installed application in the phone

Width

public int Width()

Width property getter method.

Returns:

width property used by the layout

Height

public int Height()

Height property getter method.

Returns:

height property used by the layout

switchForm

public static void switchForm(java.lang.String nextFormName)

Display a new form.

Parameters:

nextFormName - the name of the new form to display

switchFormWithStartValue

public static void switchFormWithStartValue(java.lang.String nextFormName,
                            java.lang.Object startValue)

Display a new form and pass a startup value to the new form.

Parameters:

nextFormName - the name of the new form to display

startValue - the start value to pass to the new form

startNewForm

protected void startNewForm(java.lang.String nextFormName,
                java.lang.Object startupValue)

jsonEncodeForForm

protected static java.lang.String jsonEncodeForForm(java.lang.Object value,
                                 java.lang.String functionName)

OtherScreenClosed

public void OtherScreenClosed(java.lang.String otherScreenName,
                     java.lang.Object result)

getDispatchDelegate

public HandlesEventDispatching getDispatchDelegate()

Description copied from interface: Component

Returns the dispatch delegate that is responsible for dispatching events for this component.

Specified by:

getDispatchDelegate in interface Component

$context

public android.app.Activity $context()

Description copied from interface: ComponentContainer

Returns the activity context (which can be retrieved from the root container - aka the form).

Specified by:

$context in interface ComponentContainer

Returns:

activity context

$form

public Form $form()

Description copied from interface: ComponentContainer

Returns the form that ultimately contains this container.

Specified by:

$form in interface ComponentContainer

Returns:

form

$add

public void $add(AndroidViewComponent component)

Description copied from interface: ComponentContainer

Adds a component to a container.

After this method is finished executing, the given component's view must have LayoutParams, even if the component cannot be added to the container until later.

Specified by:

$add in interface ComponentContainer

Parameters:

component - component associated with view

setChildWidth

public void setChildWidth(AndroidViewComponent component,
                 int width)

Specified by:

setChildWidth in interface ComponentContainer

setChildHeight

public void setChildHeight(AndroidViewComponent component,
                  int height)

Specified by:

setChildHeight in interface ComponentContainer

getActiveForm

public static Form getActiveForm()

getStartText

public static java.lang.String getStartText()

Returns the string that was passed to this screen when it was opened

Returns:

StartupText

getStartValue

public static java.lang.Object getStartValue()

Returns the value that was passed to this screen when it was opened

Returns:

StartValue

finishActivity

public static void finishActivity()

Closes the current screen, as opposed to finishApplication, which exits the entire application.

finishActivityWithResult

public static void finishActivityWithResult(java.lang.Object result)

finishActivityWithTextResult

public static void finishActivityWithTextResult(java.lang.String result)

closeForm

protected void closeForm(android.content.Intent resultIntent)

finishApplication

public static void finishApplication()

closeApplicationFromBlocks

protected void closeApplicationFromBlocks()

onCreateOptionsMenu

public boolean onCreateOptionsMenu(android.view.Menu menu)

Overrides:

onCreateOptionsMenu in class android.app.Activity

addExitButtonToMenu

public void addExitButtonToMenu(android.view.Menu menu)

addAboutInfoToMenu

public void addAboutInfoToMenu(android.view.Menu menu)

clear

public void clear()

deleteComponent

public void deleteComponent(java.lang.Object component)

dontGrabTouchEventsForComponent

public void dontGrabTouchEventsForComponent()

toastAllowed

protected boolean toastAllowed()

callInitialize

public void callInitialize(java.lang.Object component)
                    throws java.lang.Throwable

Throws:

java.lang.Throwable

fullScreenVideoAction

public android.os.Bundle fullScreenVideoAction(int action,
                                      VideoPlayer source,
                                      java.lang.Object data)

Perform some action related to fullscreen video display.

Parameters:

action - Can be any of the following:

• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_DURATION
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_FULLSCREEN
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_PAUSE
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_PLAY
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_SEEK
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_SOURCE
• FullScreenVideoUtil.FULLSCREEN_VIDEO_ACTION_STOP

source - The VideoPlayer to use in some actions.

data - Used by the method. This object varies depending on the action.

Returns:

Varies depending on what action was passed in.