AI2 Component  (Version nb184)
com.google.appinventor.components.runtime.Voting Class Reference
Inheritance diagram for com.google.appinventor.components.runtime.Voting:
com.google.appinventor.components.runtime.AndroidNonvisibleComponent com.google.appinventor.components.runtime.Component com.google.appinventor.components.runtime.Component

Public Member Functions

 Voting (ComponentContainer container)
 
String ServiceURL ()
 
void ServiceURL (String serviceURL)
 
String BallotQuestion ()
 
List< String > BallotOptions ()
 
String UserId ()
 
void UserId (String userId)
 
String UserChoice ()
 
void UserChoice (String userChoice)
 
String UserEmailAddress ()
 
void RequestBallot ()
 
void GotBallot ()
 
void NoOpenPoll ()
 
void SendBallot ()
 
void GotBallotConfirmation ()
 
void WebServiceError (String message)
 
- Public Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
HandlesEventDispatching getDispatchDelegate ()
 

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 = ""
 
- Protected Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
 AndroidNonvisibleComponent (Form form)
 
- Protected Attributes inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
final Form form
 

Detailed Description

The Voting component communicates with a Web service to retrieve a ballot and send back users' votes.

The application should call the method RequestBallot, usually in the Initialize event handler, in order to get the ballot question and options from the Web service (specified by the ServiceURL property). Depending on the response from the Web service, the system will raise one of the following three events:

  1. GotBallot, indicating that the ballot question and options were retrieved and the properties BallotQuestion and BallotOptions have been set.
  2. NoOpenPoll, indicating that no ballot question is available.
  3. WebServiceError, indicating that the service did not provide a legal response and providing an error messages.

After getting the ballot, the application should allow the user to make a choice from among BallotOptions and set the property UserChoice to that choice. The application should also set UserId to specify which user is voting.

Once the application has set UserChoice and UserId, the application can call SendBallot to send this information to the Web service. If the service successfully receives the vote, the event GotBallotConfirmation will be raised. Otherwise, the event WebServiceError will be raised with the appropriate error message.

Author
halab.nosp@m.elso.nosp@m.n@goo.nosp@m.gle..nosp@m.com (Hal Abelson)

Definition at line 82 of file Voting.java.

Constructor & Destructor Documentation

◆ Voting()

com.google.appinventor.components.runtime.Voting.Voting ( ComponentContainer  container)

Definition at line 110 of file Voting.java.

Member Function Documentation

◆ BallotOptions()

List<String> com.google.appinventor.components.runtime.Voting.BallotOptions ( )

The list of choices to vote.

Definition at line 167 of file Voting.java.

◆ BallotQuestion()

String com.google.appinventor.components.runtime.Voting.BallotQuestion ( )

The question to be voted on.

Definition at line 157 of file Voting.java.

◆ GotBallot()

void com.google.appinventor.components.runtime.Voting.GotBallot ( )

Event indicating that a ballot was received from the Web service.

Definition at line 359 of file Voting.java.

◆ GotBallotConfirmation()

void com.google.appinventor.components.runtime.Voting.GotBallotConfirmation ( )

Event confirming that the Voting service received the ballot.

Definition at line 422 of file Voting.java.

◆ NoOpenPoll()

void com.google.appinventor.components.runtime.Voting.NoOpenPoll ( )

Event indicating that the service has no open poll.

Definition at line 367 of file Voting.java.

◆ RequestBallot()

void com.google.appinventor.components.runtime.Voting.RequestBallot ( )

Send a request ballot command to the Voting server.

Definition at line 261 of file Voting.java.

◆ SendBallot()

void com.google.appinventor.components.runtime.Voting.SendBallot ( )

Send a ballot to the Web Voting server. The userId and the choice are specified by the UserId and UserChoice properties.

Definition at line 380 of file Voting.java.

◆ ServiceURL() [1/2]

String com.google.appinventor.components.runtime.Voting.ServiceURL ( )

The URL of the Voting Service

Definition at line 135 of file Voting.java.

◆ ServiceURL() [2/2]

void com.google.appinventor.components.runtime.Voting.ServiceURL ( String  serviceURL)

Set the URL of the Voting Service

Parameters
serviceURLthe URL (includes initial http:, but no trailing slash)

Definition at line 147 of file Voting.java.

◆ UserChoice() [1/2]

String com.google.appinventor.components.runtime.Voting.UserChoice ( )

The choice to select when sending the vote.

Definition at line 208 of file Voting.java.

◆ UserChoice() [2/2]

void com.google.appinventor.components.runtime.Voting.UserChoice ( String  userChoice)

Set the choice to select when sending the vote.

Parameters
userChoicethe choice to select. Must be one of the BallotOptions

Definition at line 218 of file Voting.java.

◆ UserEmailAddress()

String com.google.appinventor.components.runtime.Voting.UserEmailAddress ( )

Returns the registered email address, as a string, for this device's user.

Definition at line 230 of file Voting.java.

◆ UserId() [1/2]

String com.google.appinventor.components.runtime.Voting.UserId ( )

An Id that is sent to the Web server along with the vote.

Definition at line 186 of file Voting.java.

◆ UserId() [2/2]

void com.google.appinventor.components.runtime.Voting.UserId ( String  userId)

Set an Id to be sent to the Web server along with the vote.

Parameters
userIdthe string to use as the Id

Definition at line 196 of file Voting.java.

◆ WebServiceError()

void com.google.appinventor.components.runtime.Voting.WebServiceError ( String  message)

Event indicating that the communication with the Web service resulted in an error.

Parameters
messagethe error message

Definition at line 434 of file Voting.java.


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