AI2 Component  (Version nb184)
com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton > Class Template Referenceabstract
Inheritance diagram for com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >:
com.google.appinventor.components.runtime.AndroidViewComponent com.google.appinventor.components.runtime.VisibleComponent com.google.appinventor.components.runtime.Component

Public Member Functions

 ToggleBase (ComponentContainer container)
 
View getView ()
 
void Changed ()
 
void GotFocus ()
 
void LostFocus ()
 
void BackgroundColor (int argb)
 
int BackgroundColor ()
 
void Enabled (boolean enabled)
 
boolean Enabled ()
 
void FontBold (boolean bold)
 
boolean FontBold ()
 
void FontItalic (boolean italic)
 
boolean FontItalic ()
 
void FontSize (float size)
 
float FontSize ()
 
void FontTypeface (int typeface)
 
int FontTypeface ()
 
void Text (String text)
 
String Text ()
 
void TextColor (int argb)
 
int TextColor ()
 
void onCheckedChanged (CompoundButton buttonView, boolean isChecked)
 
void onFocusChange (View previouslyFocused, boolean gainFocus)
 
- Public Member Functions inherited from com.google.appinventor.components.runtime.AndroidViewComponent
boolean Visible ()
 
void Visible (boolean visibility)
 
int Width ()
 
void Width (int width)
 
void WidthPercent (int pCent)
 
void setLastWidth (int width)
 
int getSetWidth ()
 
void setLastHeight (int height)
 
int getSetHeight ()
 
void CopyWidth (AndroidViewComponent sourceComponent)
 
int Height ()
 
void Height (int height)
 
void HeightPercent (int pCent)
 
void CopyHeight (AndroidViewComponent sourceComponent)
 
int Column ()
 
void Column (int column)
 
int Row ()
 
void Row (int row)
 
HandlesEventDispatching getDispatchDelegate ()
 

Protected Member Functions

void initToggle ()
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.AndroidViewComponent
 AndroidViewComponent (ComponentContainer container)
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.VisibleComponent
 VisibleComponent ()
 

Protected Attributes

view
 
- Protected Attributes inherited from com.google.appinventor.components.runtime.AndroidViewComponent
final ComponentContainer container
 

Additional Inherited Members

- Static Public Attributes inherited from com.google.appinventor.components.runtime.Component
static final String ASSET_DIRECTORY = "component"
 
static final int ALIGNMENT_NORMAL = 0
 
static final int ALIGNMENT_CENTER = 1
 
static final int ALIGNMENT_OPPOSITE = 2
 
static final int ACCELEROMETER_SENSITIVITY_WEAK = 1
 
static final int ACCELEROMETER_SENSITIVITY_MODERATE = 2
 
static final int ACCELEROMETER_SENSITIVITY_STRONG = 3
 
static final int BUTTON_SHAPE_DEFAULT = 0
 
static final int BUTTON_SHAPE_ROUNDED = 1
 
static final int BUTTON_SHAPE_RECT = 2
 
static final int BUTTON_SHAPE_OVAL = 3
 
static final int COLOR_NONE = 0x00FFFFFF
 
static final int COLOR_BLACK = 0xFF000000
 
static final int COLOR_BLUE = 0xFF0000FF
 
static final int COLOR_CYAN = 0xFF00FFFF
 
static final int COLOR_DKGRAY = 0xFF444444
 
static final int COLOR_GRAY = 0xFF888888
 
static final int COLOR_GREEN = 0xFF00FF00
 
static final int COLOR_LTGRAY = 0xFFCCCCCC
 
static final int COLOR_MAGENTA = 0xFFFF00FF
 
static final int COLOR_ORANGE = 0xFFFFC800
 
static final int COLOR_PINK = 0xFFFFAFAF
 
static final int COLOR_RED = 0xFFFF0000
 
static final int COLOR_WHITE = 0xFFFFFFFF
 
static final int COLOR_YELLOW = 0xFFFFFF00
 
static final int COLOR_DEFAULT = 0x00000000
 
static final String DEFAULT_VALUE_COLOR_NONE = "&H00FFFFFF"
 
static final String DEFAULT_VALUE_COLOR_BLACK = "&HFF000000"
 
static final String DEFAULT_VALUE_COLOR_BLUE = "&HFF0000FF"
 
static final String DEFAULT_VALUE_COLOR_CYAN = "&HFF00FFFF"
 
static final String DEFAULT_VALUE_COLOR_DKGRAY = "&HFF444444"
 
static final String DEFAULT_VALUE_COLOR_GRAY = "&HFF888888"
 
static final String DEFAULT_VALUE_COLOR_GREEN = "&HFF00FF00"
 
static final String DEFAULT_VALUE_COLOR_LTGRAY = "&HFFCCCCCC"
 
static final String DEFAULT_VALUE_COLOR_MAGENTA = "&HFFFF00FF"
 
static final String DEFAULT_VALUE_COLOR_ORANGE = "&HFFFFC800"
 
static final String DEFAULT_VALUE_COLOR_PINK = "&HFFFFAFAF"
 
static final String DEFAULT_VALUE_COLOR_RED = "&HFFFF0000"
 
static final String DEFAULT_VALUE_COLOR_WHITE = "&HFFFFFFFF"
 
static final String DEFAULT_VALUE_COLOR_YELLOW = "&HFFFFFF00"
 
static final String DEFAULT_VALUE_COLOR_DEFAULT = "&H00000000"
 
static final float FONT_DEFAULT_SIZE = 14
 
static final int LAYOUT_ORIENTATION_HORIZONTAL = ComponentConstants.LAYOUT_ORIENTATION_HORIZONTAL
 
static final int LAYOUT_ORIENTATION_VERTICAL = ComponentConstants.LAYOUT_ORIENTATION_VERTICAL
 
static final int SCALING_SCALE_PROPORTIONALLY = 0
 
static final int SCALING_SCALE_TO_FIT = 1
 
static final int TYPEFACE_DEFAULT = 0
 
static final int TYPEFACE_SANSSERIF = 1
 
static final int TYPEFACE_SERIF = 2
 
static final int TYPEFACE_MONOSPACE = 3
 
static final int LENGTH_PREFERRED = -1
 
static final int LENGTH_FILL_PARENT = -2
 
static final int LENGTH_UNKNOWN = -3
 
static final int LENGTH_PERCENT_TAG = -1000
 
static final int TOAST_LENGTH_SHORT = 0
 
static final int TOAST_LENGTH_LONG = 1
 
static final int DIRECTION_NORTH = 1
 
static final int DIRECTION_NORTHEAST = 2
 
static final int DIRECTION_EAST = 3
 
static final int DIRECTION_SOUTHEAST = 4
 
static final int DIRECTION_SOUTH = -1
 
static final int DIRECTION_SOUTHWEST = -2
 
static final int DIRECTION_WEST = -3
 
static final int DIRECTION_NORTHWEST = -4
 
static final int DIRECTION_NONE = 0
 
static final int DIRECTION_MIN = -4
 
static final int DIRECTION_MAX = 4
 
static float SLIDER_MIN_VALUE = 10
 
static float SLIDER_MAX_VALUE = 50
 
static float SLIDER_THUMB_VALUE = (SLIDER_MIN_VALUE + SLIDER_MAX_VALUE) / 2.0f
 
static final String DEFAULT_VALUE_TEXT_TO_SPEECH_COUNTRY = ""
 
static final String DEFAULT_VALUE_TEXT_TO_SPEECH_LANGUAGE = ""
 

Detailed Description

Abstract base class for toggleable items with the ability to detect initialization, focus change (mousing on or off of it), and user clicks.

Definition at line 29 of file ToggleBase.java.

Constructor & Destructor Documentation

◆ ToggleBase()

Creates a new ToggleBase component.

Parameters
containercontainer, component will be placed in

Definition at line 55 of file ToggleBase.java.

Member Function Documentation

◆ BackgroundColor() [1/2]

int com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.BackgroundColor ( )

Returns the background color of the type% as an alpha-red-green-blue integer.

@suppressdoc

Returns
background RGB color with alpha

Definition at line 134 of file ToggleBase.java.

◆ BackgroundColor() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.BackgroundColor ( int  argb)

Specifies the background color of the type% as an alpha-red-green-blue integer.

Parameters
argbbackground RGB color with alpha

Definition at line 115 of file ToggleBase.java.

◆ Changed()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.Changed ( )

User tapped and released the type%.

Definition at line 86 of file ToggleBase.java.

◆ Enabled() [1/2]

boolean com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.Enabled ( )

Returns true if the type% is active and clickable.

@suppressdoc

Returns
true
indicates enabled,
false
disabled

Definition at line 158 of file ToggleBase.java.

◆ Enabled() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.Enabled ( boolean  enabled)

Specifies whether the type% should be active and clickable.

Parameters
enabled

Definition at line 146 of file ToggleBase.java.

◆ FontBold() [1/2]

boolean com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontBold ( )

Returns true if the text of the type% should be bold. If bold has been requested, this property will return true, even if the font does not support bold.

@suppressdoc

Returns
true
indicates bold,
false
normal

Definition at line 189 of file ToggleBase.java.

◆ FontBold() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontBold ( boolean  bold)

Specifies whether the text of the type% should be bold. Some fonts do not support bold.

Parameters
bold

Definition at line 173 of file ToggleBase.java.

◆ FontItalic() [1/2]

boolean com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontItalic ( )

Returns true if the text of the type% should be italic. If italic has been requested, this property will return true, even if the font does not support italic.

@suppressdoc

Returns
true
indicates italic,
false
normal

Definition at line 220 of file ToggleBase.java.

◆ FontItalic() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontItalic ( boolean  italic)

Specifies whether the text of the type% should be italic. Some fonts do not support italic.

Parameters
italic

Definition at line 204 of file ToggleBase.java.

◆ FontSize() [1/2]

float com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontSize ( )

Returns the text font size of the type%, measured in sp(scale-independent pixels).

@suppressdoc

Returns
font size in sp (scale-independent pixels)

Definition at line 245 of file ToggleBase.java.

◆ FontSize() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontSize ( float  size)

Specifies the text font size of the type%, measured in sp(scale-independent pixels).

Parameters
sizefont size in sp(scale-independent pixels)

Definition at line 233 of file ToggleBase.java.

◆ FontTypeface() [1/2]

int com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontTypeface ( )

Returns the text font face of the type% as default, serif, sans serif, or monospace.

@suppressdoc

Returns
one of Component#TYPEFACE_DEFAULT, Component#TYPEFACE_SERIF, Component#TYPEFACE_SANSSERIF or Component#TYPEFACE_MONOSPACE

Definition at line 281 of file ToggleBase.java.

◆ FontTypeface() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.FontTypeface ( int  typeface)

Specifies the text font face of the type% as default, serif, sans serif, or monospace.

Parameters
typefaceone of Component#TYPEFACE_DEFAULT, Component#TYPEFACE_SERIF, Component#TYPEFACE_SANSSERIF or Component#TYPEFACE_MONOSPACE

Definition at line 263 of file ToggleBase.java.

◆ getView()

View com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.getView ( )

Returns the View that is displayed in the UI.

Reimplemented from com.google.appinventor.components.runtime.AndroidViewComponent.

Definition at line 78 of file ToggleBase.java.

◆ GotFocus()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.GotFocus ( )

type% became the focused component.

Definition at line 94 of file ToggleBase.java.

◆ initToggle()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.initToggle ( )
protected

Definition at line 60 of file ToggleBase.java.

◆ LostFocus()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.LostFocus ( )

type% stopped being the focused component.

Definition at line 102 of file ToggleBase.java.

◆ onCheckedChanged()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.onCheckedChanged ( CompoundButton  buttonView,
boolean  isChecked 
)

Definition at line 343 of file ToggleBase.java.

◆ onFocusChange()

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.onFocusChange ( View  previouslyFocused,
boolean  gainFocus 
)

Definition at line 349 of file ToggleBase.java.

◆ Text() [1/2]

String com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.Text ( )

Returns the text displayed by the type%.

@suppressdoc

Returns
toggle's caption

Definition at line 304 of file ToggleBase.java.

◆ Text() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.Text ( String  text)

Specifies the text displayed by the type%.

Parameters
textnew caption for toggleable button

Definition at line 292 of file ToggleBase.java.

◆ TextColor() [1/2]

int com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.TextColor ( )

Returns the text color of the type% as an alpha-red-green-blue integer.

@suppressdoc

Returns
text RGB color with alpha

Definition at line 337 of file ToggleBase.java.

◆ TextColor() [2/2]

void com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.TextColor ( int  argb)

Specifies the text color of the type% as an alpha-red-green-blue integer.

Parameters
argbtext RGB color with alpha

Definition at line 318 of file ToggleBase.java.

Member Data Documentation

◆ view

T com.google.appinventor.components.runtime.ToggleBase< T extends CompoundButton >.view
protected

Definition at line 32 of file ToggleBase.java.


The documentation for this class was generated from the following file: