Press on the image to return to the main documentation page.
jFXtrasControls
Written by Andrew Graham
This library contains additional controls from JFXtras Labs. JFXtraBreadcrumbBar, JFXtraBreadcrumbItem, JFXtraNumberUpDown, JFXtraDatePicker, JFXtraTimePicker and JFXtraListSpinner. This library uses the jfxtras-labs-2.2-r5.jar library from JFXtras Labs. This is the direct link to jfxtras-labs-2.2-r5.jar
To integrate these controls with SceneBuilder you need to manually add this line to your fxml layout file after the existing set of imports at the start of the file. Note that in the following lines I've used [ and ] instead of greater and less than characters to ensure the lines are not treated as mark-up in the help.
[?import jfxtras.labs.scene.control.*?]
Then in SceneBuilder add a simple control, TextArea is a good one, and name with a Node Id for B4J. Position and size the controls and do the same for any other controls you want then close SceneBuilder. Manually edit the fxml again by finding the TextArea lines
[TextArea id="Battery1" layoutX="49.0" layoutY="173.0" prefHeight="106.0" prefWidth="105.0" wrapText="true" /] and change 'TextArea' to the required type and remove 'wrapText' [XYControl id="XYControl1" layoutX="49.0" layoutY="173.0" prefHeight="106.0" prefWidth="105.0" /] SceneBuilder type names are specified in the xml help for each control
When you next start SceneBuilder it will want a path to the unknown controls. Check "Set up classpath", click the "+ Jar..." button and locate jfxtras-labs-2.2-r5.jar. Click "Apply" and "Close". You will have to do this each time you restart SceneBuilder, although the path will be already selected, but for some reason SceneBuilder will not automatically use it.
The controls should now be visible in SceneBuilder and also visible to "Generate Members" in B4J.
JFXtras and JFXtras Labs are licensed under the New BSD License. Copyright (c) 2013, JFXtras All rights reserved.
This library is therefore also licensed under the New BSD License.
This object implements a BreadcrumbBar that contains BreadcrumbItems and an optional Home item. BreadcrumbItems are displayed horizontally in the order in which they are added. Clicking any BreadcrumbItem removes both it and any items added after it with exception that the Home item is never removed if clicked.
The ItemAction event is raised when an item in the BreadcrumbBar is clicked.
The SceneBuilder name for this control is 'BreadcrumbBar'
This BreadcrumbItem object can be added to a BreadcrumbBar. The only way of obtaining a BreadcrumbItem is from the return of BreadcrumbBar.AddItem. A BreadcrumbItem can display text, an image or both.
The SceneBuilder name for this control is 'BreadcrumbItem'
This DatePicker allows dates and times to be selected. It does not provide any events so some other mechanism will be needed for the user to indicate that the required selection has been made, most likely a custom modal dialog.
The SceneBuilder name for this control is 'CalendarPicker'
Gets or sets the date and time of the DatePicker as value in ticks.
EnabledAsBoolean
HeightAsDouble [read only]
IdAsString
Initialize (arg1AsString)
IsInitializedAsBoolean
LeftAsDouble
ModeAsString
Gets or sets the mode of the DatePicker. Valid values are "SINGLE" - allows only a single date to be selected by clicking on it "RANGE" - allows a single range of dates to be selected bu Shift-Click on the second date "MULTIPLE" - allows multiple dates and date ranges to be selected.
Note that deselecting a date in MULTIPLE mode seems a little buggy, needing two clicks at times.
MouseCursorAsjavafx.scene.Cursor
PrefHeightAsDouble
PrefWidthAsDouble
RemoveNodeFromParent
RequestFocus
ShowTimeAsBoolean
Gets or sets the ShowTime property of the DatePicker. This is only valid in SINGLE mode as this is the only mode where the time selector can be used.
SnapshotAsImageWrapper
StyleAsString
StyleClassesAsList [read only]
TagAsObject
TimeZoneAsInt [write only]
Sets the time zone offset of the DatePicker. This is only valid in SINGLE mode as this is the only mode where the time selector can be used.
This DateTextField allows dates and times to be selected and returned as a formatted text value. If the user hovers over the field a tooltip will pop up detailing how to enter values in the control. It does not provide any events so some other mechanism will be needed for the user to indicate that the required selection has been made, most likely a custom modal dialog.
The SceneBuilder name for this control is 'CalendarTextField'
Gets or sets the format used to parse date strings. See this page for the supported patterns: formats:. The default pattern is MM/dd/yyyy (04/23/2002 for example).
DateTimeAsLong
Gets or sets the date and time of the DateTextField as value in ticks.
This ListSpinner control allows the user to select from a List of strings. The List may be maintained by adding to and removing from the default List of the ListSpinner. ListSpinner implements most of the methods of a B4J List to enable this to done in a familiar way. Otherwise a ready built B4J List that must contain only Strings may be assigned to the controls Items property.
The ListSpinner may be editable or read-only. If editable then when the user enters a new string the AddCallback event is raised passing the new string as a parameter. The AddCallBack event Sub should return an int value that is the index of the item to be displayed to the user.
The Cycle event is raised when the control wraps round in either direction.
The SceneBuilder name for this control is 'ListSpinner'
Events:
Cycle 'The Cylic property is True and the user has cycled from one end of the list to the other AddCallBack As String) 'The ListSpinner is Editable and the user has entered a new item into the ListSpinner
Adds all elements in the specified collection to the end of the list.
AddAllAt (indexAsInt, ListAsList)
Adds all elements in the specified collection starting at the specified index.
ArrowsPositionAsString
Gets or sets the position of the arrows. Valid values are "LEADING" - positions both arrows to the left of the ListSpinner. "SPLIT" - positions the above/below or left.right according to the value of VerticalArrows. "TRAILING" - positions both arrows to the right of the ListSpinner.
ArrowsVerticalAsBoolean
Gets or sets whether the ListSpinner arrows are vertically oriented..
Clear
Removes all the items from the list.
ContextMenuAsContextMenuWrapper
CyclicAsBoolean
Gets or sets whether the ListSpinner cycles to the beginning when the user gets to the last item.
EditableAsBoolean
Gets or sets whether the user can enter new items.
EnabledAsBoolean
Get (indexAsInt) AsString
Gets the item in the specified index. The item is not removed from the list.
HeightAsDouble [read only]
IdAsString
IndexAsInt
Gets or sets the index in the List of the item that is to be displayed to the user.
IndexOf (itemAsString) AsInt
Returns the index of the specified item, or -1 if it was not found.
Initialize (arg1AsString)
InsertAt (indexAsInt, itemAsString)
Inserts the specified Item in the specified index. As a result all items with index larger than the specified index are moved.
IsInitializedAsBoolean
ItemsAsList
Gets or sets a List containing the strings the user can select.
LeftAsDouble
MouseCursorAsjavafx.scene.Cursor
PrefHeightAsDouble
PrefWidthAsDouble
RemoveAt (indexAsInt)
Removes the item at the specified index.
RemoveNodeFromParent
RequestFocus
Set (indexAsInt, itemAsString)
Replaces the current item in the specified index with the new item.
SizeAsInt [read only]
Returns the number of items in the list.
SnapshotAsImageWrapper
Sort (ascendingAsBoolean)
Sorts the list.
SortCaseInsensitive (AscendingAsBoolean)
Sorts the list ignoring the characters case.
StyleAsString
StyleClassesAsList [read only]
TagAsObject
TooltipTextAsString
TopAsDouble
ValueAsString
Gets or sets the value of the item that is currently being displayed to the user.
This NumberUpDown control allows the user to specify a number. A number may be entered by the user and accepted by pressing the Enter key. The number may be spun up and down by the arrows using a step value set by the application program. Numbers are not restricted to integers, the underlying type of the number is a Bigdecimal. The NumberUpDown can format the number using a specified pattern. It does not provide any events so some other mechanism will be needed for the user to indicate that the required selection has been made.
The SceneBuilder name for this control is 'BigDecimalField'
Gets or sets the Format property of the NumberUpDown with the specified pattern. Refer to the documentation for java.text.DecimalFormat for a description of patterns.
HeightAsDouble [read only]
IdAsString
Increment
Initialize (arg1AsString)
IsInitializedAsBoolean
LeftAsDouble
MaxValueAsDouble
Gets or sets the MaxValue property of the NumberUpDown
MinValueAsDouble
Gets or sets the MinValue property of the NumberUpDown
MouseCursorAsjavafx.scene.Cursor
NumberAsDouble
Gets or sets the Number property of the NumberUpDown
This TimePicker allows a time to be selected. It does not provide any events so some other mechanism will be needed for the user to indicate that the required selection has been made, most likely a custom modal dialog.
The SceneBuilder name for this control is 'CalendarTimePicker'
This TimeTextField allows times to be selected and returned as a formatted text value. If the user hovers over the field a tooltip will pop up detailing how to enter values in the control. It does not provide any events so some other mechanism will be needed for the user to indicate that the required selection has been made, most likely a custom modal dialog.
The SceneBuilder name for this control is 'CalendarTimeTextField'
Gets or sets the date and time of the TimeTextField as value in ticks.
EnabledAsBoolean
HeightAsDouble [read only]
IdAsString
Initialize (arg1AsString)
IsInitializedAsBoolean
LeftAsDouble
MouseCursorAsjavafx.scene.Cursor
PrefHeightAsDouble
PrefWidthAsDouble
RemoveNodeFromParent
RequestFocus
ShowLabelsAsBoolean
Gets or sets the ShowLabels property of the TimeTextField.
SnapshotAsImageWrapper
StyleAsString
StyleClassesAsList [read only]
TagAsObject
TimeFormatAsString
Gets or sets the format used to parse time strings. See this page for the supported patterns: formats:. The default pattern is HH:mm:ss (23:45:12 for example).