1.06
anywheresoftware.b4a.agraham.dialogs.InputDialog
InputDialog
This modal dialog allows the collection of user entered data in the form of text.
The default is free text but the input can be restricted to numeric characters only
or to signed numbers including a decimal point.
activity
Show
Shows a modal text input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
message
java.lang.String
title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
Input
java.lang.String
value
java.lang.String
Sets the initial text when the dialog is shown and returns the text entered by the user.
PasswordMode
boolean
value
boolean
Sets or returns whether this dialog hides the actual characters entered by the user.
InputType
int
inputtype
int
Sets or returns the input type accepted by the input box.Possible values are:
ThisDialogName.INPUT_TYPE_NUMBERS for integer numbers.
ThisDialogName.INPUT_TYPE_DECIMAL_NUMBER for signed decimal numbers.
ThisDialogName.INPUT_TYPE_TEXT for free text.
ThisDialogName.INPUT_TYPE_PHONE for telephone numbers.
HintColor
int
hintcolor
int
Gets or sets the hint text color.
Response
int
Returns the response code that the dialog returned when it last closed.
Hint
java.lang.String
hint
java.lang.String
Gets or sets the text that will appear when the dialog is empty.
Version
double
Returns the version of the library.
INPUT_TYPE_NUMBERS
int
INPUT_TYPE_DECIMAL_NUMBERS
int
INPUT_TYPE_TEXT
int
INPUT_TYPE_PHONE
int
INPUT_TYPE_NONE
int
anywheresoftware.b4a.agraham.dialogs.InputDialog.DateDialog
DateDialog
This modal dialog allows the collection of user entered data in the form of a date.
activity
Show
Shows a modal date input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
Message
java.lang.String
Title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
SetDate
Sets the date values of the dialog when is intially shown.
void
dayofmonth
int
month
int
year
int
DayOfMonth
int
day
int
Sets the day of month value of the dialog when is intially shown.
Returns the day of month value of the dialog when it is closed.
Year
int
year
int
Sets the year value of the dialog when is intially shown.
Returns the year value of the dialog when it is closed.
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
Month
int
month
int
Sets the month value of the dialog when is intially shown.
Returns the month value of the dialog when it is closed.
DateTicks
long
ticks
long
Sets the date value of the dialog when is intially shown.
Returns the date value in ticks of the dialog when it is closed.
ShowCalender
boolean
anywheresoftware.b4a.agraham.dialogs.InputDialog.TimeDialog
TimeDialog
This modal dialog allows the collection of user entered data in the form of a time.
The time may be entered in 12 or 24 hour format as determined by the programmer.
activity
Show
Shows a modal time input dialog with the specified message and title.
Message - The dialog message.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
Message
java.lang.String
Title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
SetTime
Sets the time values of the dialog when is intially shown.
void
hour
int
minutes
int
hours24
boolean
Hour
int
hour
int
Sets the hour value of the dialog when is intially shown.
Returns the hour value of the dialog when it is closed.
Is24Hours
boolean
is24hours
boolean
Sets or returns whether the dialog shows the time in 24 hour format.
Response
int
Returns the response code that the dialog returned when it last closed.
Minute
int
minute
int
Sets the minute value of the dialog when is intially shown.
Returns the minute value of the dialog when it is closed.
Version
double
Returns the version of the library.
TimeTicks
long
ticks
long
Sets the time value of the dialog when is intially shown.
Returns the time value in ticks of the dialog when it is closed.
anywheresoftware.b4a.agraham.dialogs.InputDialog.ColorDialog
ColorDialog
This modal dialog allows the user to define a colour by its Red, Green and Blue components.
activity
ARGB
Returns an integer value representing the color built from the three components and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.
int
alpha
int
Show
Shows a modal color dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
Blue
int
blue
int
Sets the value of the blue component of the dialog when is intially shown.
Returns the value of the blue component of the dialog when it was closed.
Red
int
red
int
Sets the value of the red component of the dialog when is intially shown.
Returns the value of the red component of the dialog when it was closed.
Green
int
green
int
Sets the value of the green component of the dialog when is intially shown.
Returns the value of the green component of the dialog when it was closed.
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
RGB
int
color
int
Sets the value of the red, green and blue components of the dialog when is intially shown.
Returns the color of the red, green and blue components of the dialog when it was closed.
Alpha of the provided color is ignored on set and implicitly set to 255 (opaque) on get.
anywheresoftware.b4a.agraham.dialogs.InputDialog.ColorDialogHSV
ColorDialogHSV
This modal dialog allows the user to define a colour by its Hue, Saturation and Value components.
activity
ARGB
Returns an integer value representing the color built from the three components and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.
int
alpha
int
Show
Shows a modal color dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
Value
float
value
float
Sets the value of the value component of the dialog when is intially shown.
Returns the value of the value component of the dialog when it was closed.
The range of valid numbers for value is 0.0 to 1.0.
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
RGB
int
color
int
Sets the value of the red, green and blue components of the dialog when is intially shown.
Returns the color of the red, green and blue components of the dialog when it was closed.
Alpha of the provided color is ignored on set and implicitly set to 255 (opaque) on get.
Saturation
float
saturation
float
Sets the value of the saturation component of the dialog when is intially shown.
Returns the value of the saturation component of the dialog when it was closed.
The range of valid numbers for saturation is 0.0 to 1.0.
Hue
float
hue
float
Sets the value of the hue component of the dialog when is intially shown.
Returns the value of the hue component of the dialog when it was closed.
The range of valid numbers for hue is 0.0 to 360.0.
anywheresoftware.b4a.agraham.dialogs.InputDialog.ColorPickerDialog
ColorPickerDialog
This modal dialog allows the user to select a colour from a palette of colours.
The color may be from a standard palette in the dialog or a custom programmed palette.
activity
ARGB
Returns an integer value representing the color built from the chosen color and with the specified alpha value.
Alpha - A value between 0 to 255 where 0 is fully transparent and 255 is fully opaque.
int
alpha
int
SetPaletteAt
Sets the value of the color at the specified index in the current palette.
This allows replacing just one or two colors without defining an entire palette.
void
index
int
color
int
Show
Shows a modal color picker dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
ResetPalette
Reset the palette of colors to the standard palette of the dialog.
void
GetPaletteAt
Gets the value of the color at the specified index in the current palette.
int
index
int
Palette
int[]
palette
int[]
Copies the colours in the array provided to the palette of colors in the dialog.
The provided array should contain 15 colors.
Returns an integer array that is a copy of the present palette.
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
RGB
int
color
int
Sets the value of the chosen color of the dialog when is intially shown.
Returns the value of the chosen color of the dialog when it was closed.
anywheresoftware.b4a.agraham.dialogs.InputDialog.NumberDialog
NumberDialog
This configurable modal dialog allows the user to enter a number.
The dialog is configurable to show any number of digits between a minimum of one and a maximum of eight.
The display of a decimal point is optional and the character displayed as the decimal indicator is configurable.
Note that the number accepted and returned by the dialog is an integer value and so may need scaling appropriately.
activity
Show
Shows a modal number picker dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
DecimalChar
char
decimalchar
char
Gets or sets the displayed decimal character in the dialog.
The default is ".".
Decimal
int
digits
int
Gets or sets the position of a displayed decimal point in the dialog.
Zero displays no decimals, one indicates a single decimal, and so on.
Number
int
number
int
Sets the number initially displayed in the dialog when it is shown.
If the number is negative and ShowSign is False then the absolute value is displayed
Gets the number entered by the user after the dialog is closed.
If ShowSign is True the sign of the number corresponds to the sign entered by the user.
Response
int
Returns the response code that the dialog returned when it last closed.
Digits
int
digits
int
Gets or sets the number of digits displayed in the dialog when it is open.
One is the minimum, nine is the maximum. The default is five.
If ShowSign is True then the leftmost digit will display a "+" or "-".
Version
double
Returns the version of the library.
ShowSign
boolean
show
boolean
Gets or sets whether the displayed number includes a sign character.
The default is False, no absolute value of the input number is displayed.
anywheresoftware.b4a.agraham.dialogs.InputDialog.FileDialog
FileDialog
This modal dialog allows the user to choose a folder and choose or enter a filename.
activity
Show
Shows a modal file dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
Title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
ChosenName
java.lang.String
filename
java.lang.String
Sets the filename initially shown to the user.
Returns the filename entered or chosen by the user.
ShowOnlyFolders
boolean
onlyfolders
boolean
Gets or sets whether to show only folders and not files in the dialog.
ScrollingBackgroundColor
int
scrollcolor
int
Gets or sets the background color that will be used while scrolling the list.
This is an optimization done to make the scrolling smoother.
Set to Colors.Transparent if the background behind the list is not solid color.
The default whatever is the default for the particular device
Response
int
Returns the response code that the dialog returned when it last closed.
FileFilter
java.lang.String
filetype
java.lang.String
Gets or sets the filter values of the dialog.
The filter can be a single value ".txt"
The filter can also be a comma separated list of values ".jpg,.png".
Note that spaces in filter values are significant and are not ignored.
If a filename contains the text of a filter value the file will be displayed.
A value of an empty string, the default, will show all files.
FilePath
java.lang.String
path
java.lang.String
Sets the file path of the dialog when it is intially shown.
Returns the file path of the dialog when it is closed.
Note that setting the file path also sets ChosenName to an empty string.
Version
double
Returns the version of the library.
FastScroll
boolean
fastscroll
boolean
Gets or sets whether the fast scroll thumb is displayed by the dialog.
anywheresoftware.b4a.agraham.dialogs.InputDialog.CustomDialog
CustomDialog
This modal dialog displays a custom set of controls laid out on a Basic4android Panel.
The Panel is displayed at an abolute position and size within the dialog.
activity
AddView
Adds the custom layout view, most probably a Panel, to the custom dialog.
Although named AddView to match Basic4androd syntax only one view can be added.
Adding a view replaces any existing view previously added to the dialog.
void
view
android.view.View
left
int
top
int
width
int
height
int
Show
Shows a modal custom dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
Title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
anywheresoftware.b4a.agraham.dialogs.InputDialog.CustomDialog2
CustomDialog2
This modal dialog displays a custom set of controls laid out on a Basic4android Panel.
The Panel will be automatically centred in the displayed dialog.
activity
AddView
Adds the custom layout view, most probably a Panel, to the custom dialog.
Although named AddView to match Basic4androd syntax only one view can be added.
Adding a view replaces any existing view previously added to the dialog.
void
view
android.view.View
width
int
height
int
Show
Shows a modal custom dialog with the specified title.
Title - The dialog title.
Positive - The text to show for the "positive" button. Pass "" if you don't want to show the button.
Cancel - The text to show for the "cancel" button. Pass "" if you don't want to show the button.
Negative - The text to show for the "negative" button. Pass "" if you don't want to show the button.
Icon - A bitmap that will be drawn near the title. Pass Null if you don't want to show an icon.
Returns one of the DialogResponse values.
int
Title
java.lang.String
Positive
java.lang.String
Cancel
java.lang.String
Negative
java.lang.String
ba
anywheresoftware.b4a.BA
icon
android.graphics.Bitmap
Response
int
Returns the response code that the dialog returned when it last closed.
Version
double
Returns the version of the library.
2.96
This library contains several modal, that is blocking, dialogs by which the user
can enter data. Presently they are an InputDialog for text, a TimeDialog for times,
a DateDialog for dates, both a ColorDialog and a ColorPickerDialog for colors, a
NumberDialog for numbers,a FileDialog for folders and file names and a CustomDialog.
Android does not provide modal dialogs but a special mechanism to permit this exists
in Basic4android. The Android Activity lifetime system makes this support complicated
because Activities can be created and destroyed at will by the OS. To avoid stack
runaway on the GUI thread when an Activity is destroyed the stack must be unwound to
the lowest level. The Basic4android modal mechanism does this by closing any modal
dialog being shown and exiting the Sub that called the dialog, and any Sub that called
that Sub and so on, in order to return the main thread to the message loop. This means
that the application does not necessarily receive a return value from the dialog and has
its expected flow of execution interrupted. This will probably most often happen if the
device is rotated while a modal dialog is displayed so the Activity is destroyed and rebuilt
with a new layout.
Because this may happen unexpectedly applications, depending upon their logical structure,
may need code in the Pause and Resume Subs to deal with the fact that modal dialog closure
may not always be detected. Setting a process global when a modal dialog is shown and
clearing it when it returns with some checking code in the Resume Sub is one way of dealing
with this possibility.
The above discussion also applies the Basic4android modal dialogs InputList, InputMultiList,
Msgbox and Msgbox2.
Andrew Graham