com.google.appinventor.components.runtime

Class ButtonBase

java.lang.Object

com.google.appinventor.components.runtime.VisibleComponent

com.google.appinventor.components.runtime.AndroidViewComponent

com.google.appinventor.components.runtime.ButtonBase

All Implemented Interfaces:

android.view.View.OnClickListener, android.view.View.OnFocusChangeListener, android.view.View.OnLongClickListener, android.view.View.OnTouchListener, Component

Direct Known Subclasses:

Button, DatePicker, Picker, TimePicker

public abstract class ButtonBase
extends AndroidViewComponent
implements android.view.View.OnClickListener, android.view.View.OnFocusChangeListener, android.view.View.OnLongClickListener, android.view.View.OnTouchListener

Underlying base class for click-based components, not directly accessible to Simple programmers.

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidViewComponent

container

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

Constructor Summary

Constructors

Constructor and Description
ButtonBase(ComponentContainer container) Creates a new ButtonBase component.

Method Summary

Methods

Modifier and Type	Method and Description
int	BackgroundColor() Returns the button's background color as an alpha-red-green-blue integer.
void	BackgroundColor(int argb) Specifies the button's background color as an alpha-red-green-blue integer.
abstract void	click()
boolean	Enabled() Returns true if the button is active and clickable.
void	Enabled(boolean enabled) Specifies whether the button should be active and clickable.
boolean	FontBold() Returns true if the button's text should be bold.
void	FontBold(boolean bold) Specifies whether the button's text should be bold.
boolean	FontItalic() Returns true if the button's text should be italic.
void	FontItalic(boolean italic) Specifies whether the button's text should be italic.
float	FontSize() Returns the button's text's font size, measured in pixels.
void	FontSize(float size) Specifies the button's text's font size, measured in pixels.
int	FontTypeface() Returns the button's text's font face as default, serif, sans serif, or monospace.
void	FontTypeface(int typeface) Specifies the button's text's font face as default, serif, sans serif, or monospace.
android.view.View	getView() Returns the View that is displayed in the UI.
void	GotFocus() Indicates the cursor moved over the button so it is now possible to click it.
java.lang.String	Image() Returns the path of the button's image.
void	Image(java.lang.String path) Specifies the path of the button's image.
boolean	longClick()
void	LostFocus() Indicates the cursor moved away from the button so it is now no longer possible to click it.
void	onClick(android.view.View view)
void	onFocusChange(android.view.View previouslyFocused, boolean gainFocus)
boolean	onLongClick(android.view.View view)
boolean	onTouch(android.view.View view, android.view.MotionEvent me) If a custom background images is specified for the button, then it will lose the pressed and disabled image effects; no visual feedback.
int	Shape() Returns the style of the button.
void	Shape(int shape) Specifies the style the button.
boolean	ShowFeedback() Returns true if the button's text should be bold.
void	ShowFeedback(boolean showFeedback) Specifies if a visual feedback should be shown when a button with an assigned image is pressed.
java.lang.String	Text() Returns the text displayed by the button.
void	Text(java.lang.String text) Specifies the text displayed by the button.
int	TextAlignment() Returns the alignment of the button's text: center, normal (e.g., left-justified if text is written left to right), or opposite (e.g., right-justified if text is written left to right).
void	TextAlignment(int alignment) Specifies the alignment of the button's text: center, normal (e.g., left-justified if text is written left to right), or opposite (e.g., right-justified if text is written left to right).
int	TextColor() Returns the button's text color as an alpha-red-green-blue integer.
void	TextColor(int argb) Specifies the button's text color as an alpha-red-green-blue integer.
void	TouchDown() Indicates when a button is touch down
void	TouchUp() Indicates when a button touch ends

Methods inherited from class com.google.appinventor.components.runtime.AndroidViewComponent

Column, Column, CopyHeight, CopyWidth, getDispatchDelegate, Height, Height, Row, Row, Visible, Visible, Width, Width

Methods inherited from class java.lang.Object

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

Constructor Detail

ButtonBase

public ButtonBase(ComponentContainer container)

Creates a new ButtonBase component.

Parameters:

container - container, component will be placed in

Method Detail

onTouch

public boolean onTouch(android.view.View view,
              android.view.MotionEvent me)

If a custom background images is specified for the button, then it will lose the pressed and disabled image effects; no visual feedback. The approach below is to provide a visual feedback if and only if an image is assigned to the button. In this situation, we overlay a gray background when pressed and release when not-pressed.

Specified by:

onTouch in interface android.view.View.OnTouchListener

getView

public android.view.View getView()

Description copied from class: AndroidViewComponent

Returns the View that is displayed in the UI.

Specified by:

getView in class AndroidViewComponent

TouchDown

public void TouchDown()

Indicates when a button is touch down

TouchUp

public void TouchUp()

Indicates when a button touch ends

GotFocus

public void GotFocus()

Indicates the cursor moved over the button so it is now possible to click it.

LostFocus

public void LostFocus()

Indicates the cursor moved away from the button so it is now no longer possible to click it.

TextAlignment

public int TextAlignment()

Returns the alignment of the button's text: center, normal (e.g., left-justified if text is written left to right), or opposite (e.g., right-justified if text is written left to right).

Returns:

one of Component.ALIGNMENT_NORMAL, Component.ALIGNMENT_CENTER or Component.ALIGNMENT_OPPOSITE

TextAlignment

public void TextAlignment(int alignment)

Specifies the alignment of the button's text: center, normal (e.g., left-justified if text is written left to right), or opposite (e.g., right-justified if text is written left to right).

Parameters:

alignment - one of Component.ALIGNMENT_NORMAL, Component.ALIGNMENT_CENTER or Component.ALIGNMENT_OPPOSITE

Shape

public int Shape()

Returns the style of the button.

Returns:

one of Component.BUTTON_SHAPE_DEFAULT, Component.BUTTON_SHAPE_ROUNDED, Component.BUTTON_SHAPE_RECT or Component.BUTTON_SHAPE_OVAL

Shape

public void Shape(int shape)

Specifies the style the button. This does not check that the argument is a legal value.

Parameters:

shape - one of Component.BUTTON_SHAPE_DEFAULT, Component.BUTTON_SHAPE_ROUNDED, Component.BUTTON_SHAPE_RECT or Component.BUTTON_SHAPE_OVAL

Throws:

java.lang.IllegalArgumentException - if shape is not a legal value.

Image

public java.lang.String Image()

Returns the path of the button's image.

Returns:

the path of the button's image

Image

public void Image(java.lang.String path)

Specifies the path of the button's 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 button's image

BackgroundColor

public int BackgroundColor()

Returns the button's background color as an alpha-red-green-blue integer.

Returns:

background RGB color with alpha

BackgroundColor

public void BackgroundColor(int argb)

Specifies the button's background color as an alpha-red-green-blue integer. If the parameter is Component.COLOR_DEFAULT, the original beveling is restored. If an Image has been set, the color change will not be visible until the Image is removed.

Parameters:

argb - background RGB color with alpha

Enabled

public boolean Enabled()

Returns true if the button is active and clickable.

Returns:

true indicates enabled, false disabled

Enabled

public void Enabled(boolean enabled)

Specifies whether the button should be active and clickable.

Parameters:

enabled - true for enabled, false disabled

FontBold

public boolean FontBold()

Returns true if the button's text should be bold. If bold has been requested, this property will return true, even if the font does not support bold.

Returns:

true indicates bold, false normal

FontBold

public void FontBold(boolean bold)

Specifies whether the button's text should be bold. Some fonts do not support bold.

Parameters:

bold - true indicates bold, false normal

ShowFeedback

public void ShowFeedback(boolean showFeedback)

Specifies if a visual feedback should be shown when a button with an assigned image is pressed.

Parameters:

showFeedback - true enables showing feedback, false disables it

ShowFeedback

public boolean ShowFeedback()

Returns true if the button's text should be bold. If bold has been requested, this property will return true, even if the font does not support bold.

Returns:

true indicates visual feedback will be shown, false visual feedback will not be shown

FontItalic

public boolean FontItalic()

Returns true if the button's text should be italic. If italic has been requested, this property will return true, even if the font does not support italic.

Returns:

true indicates italic, false normal

FontItalic

public void FontItalic(boolean italic)

Specifies whether the button's text should be italic. Some fonts do not support italic.

Parameters:

italic - true indicates italic, false normal

FontSize

public float FontSize()

Returns the button's text's font size, measured in pixels.

Returns:

font size in pixel

FontSize

public void FontSize(float size)

Specifies the button's text's font size, measured in pixels.

Parameters:

size - font size in pixel

FontTypeface

public int FontTypeface()

Returns the button's text's font face as default, serif, sans serif, or monospace.

Returns:

one of Component.TYPEFACE_DEFAULT, Component.TYPEFACE_SERIF, Component.TYPEFACE_SANSSERIF or Component.TYPEFACE_MONOSPACE

FontTypeface

public void FontTypeface(int typeface)

Specifies the button's text's font face as default, serif, sans serif, or monospace.

Parameters:

typeface - one of Component.TYPEFACE_DEFAULT, Component.TYPEFACE_SERIF, Component.TYPEFACE_SANSSERIF or Component.TYPEFACE_MONOSPACE

Text

public java.lang.String Text()

Returns the text displayed by the button.

Returns:

button caption

Text

public void Text(java.lang.String text)

Specifies the text displayed by the button.

Parameters:

text - new caption for button

TextColor

public int TextColor()

Returns the button's text color as an alpha-red-green-blue integer.

Returns:

text RGB color with alpha

TextColor

public void TextColor(int argb)

Specifies the button's text color as an alpha-red-green-blue integer.

Parameters:

argb - text RGB color with alpha

click

public abstract void click()

longClick

public boolean longClick()

onClick

public void onClick(android.view.View view)

Specified by:

onClick in interface android.view.View.OnClickListener

onFocusChange

public void onFocusChange(android.view.View previouslyFocused,
                 boolean gainFocus)

Specified by:

onFocusChange in interface android.view.View.OnFocusChangeListener

onLongClick

public boolean onLongClick(android.view.View view)

Specified by:

onLongClick in interface android.view.View.OnLongClickListener