Top Description Fields Constructors Methods
com.dlsc.gemsfx

public Class ChipsViewContainer

extends FlowPane
Class Inheritance
Imports
javafx.beans.Observable, javafx.beans.property.ListProperty, .ObjectProperty, .SimpleListProperty, .SimpleObjectProperty, .SimpleStringProperty, .StringProperty, javafx.collections.FXCollections, .ObservableList, javafx.scene.control.Hyperlink, javafx.scene.layout.FlowPane, java.util.Objects

A container used for displaying several ChipView instances. This view is usually used in combination with a parent filter view (e.g. SimpleFilterView). The view also manages a hyperlink for clearing the current selection settings iin the parent view. The view manages its own visibility based on whether there are any chip views to show or not.
See Also
chipsProperty(), SimpleFilterView#chipsProperty()

Field Summary

Modifier and TypeField and Description
private final ListProperty<ChipView<?>>
private final StringProperty
public final ObjectProperty<Runnable>

Constructor Summary

AccessConstructor and Description
public
ChipsViewContainer()

Constructs a new chips view container.

Method Summary

Modifier and TypeMethod and Description
public final ListProperty<ChipView<?>>

Returns:

the chip views
chipsProperty
()

The list of chip views that will be shown by the view.

public final StringProperty

Returns:

the text property used for the text of the hyperlink used to clear the view
clearTextProperty
()

A property storing the text for the hyperlink that is being used to clear the view.

public final ObservableList<ChipView<?>>
public final String
public final Runnable
public String
getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.

public final ObjectProperty<Runnable>

Returns:

the "on clear" callback
onClearProperty
()

A callback that will be invoked when the user clicks on the "clear" hyperlink.

public final void
public final void
setClearText(String clearText)

public final void
private void
Inherited from javafx.scene.layout.FlowPane:
alignmentPropertyclearConstraintscolumnHalignmentPropertycomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthgetAlignmentgetClassCssMetaDatagetColumnHalignmentgetContentBiasgetCssMetaDatagetHgapgetMargingetOrientationgetPrefWrapLengthgetRowValignmentgetVgaphgapPropertylayoutChildrenorientationPropertyprefWrapLengthPropertyrequestLayoutrowValignmentPropertysetAlignmentsetColumnHalignmentsetHgapsetMarginsetOrientationsetPrefWrapLengthsetRowValignmentsetVgapvgapProperty

Field Detail

chipsback to summary
private final ListProperty<ChipView<?>> chips
clearTextback to summary
private final StringProperty clearText
onClearback to summary
public final ObjectProperty<Runnable> onClear

Constructor Detail

ChipsViewContainerback to summary
public ChipsViewContainer()

Constructs a new chips view container.

Method Detail

chipsPropertyback to summary
public final ListProperty<ChipView<?>> chipsProperty()

The list of chip views that will be shown by the view.

Returns:ListProperty<ChipView<?>>

the chip views

clearTextPropertyback to summary
public final StringProperty clearTextProperty()

A property storing the text for the hyperlink that is being used to clear the view.

Returns:StringProperty

the text property used for the text of the hyperlink used to clear the view

See Also
onClearProperty()
getChipsback to summary
public final ObservableList<ChipView<?>> getChips()
getClearTextback to summary
public final String getClearText()
getOnClearback to summary
public final Runnable getOnClear()
getUserAgentStylesheetback to summary
public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}
For additional information about using CSS with the scene graph, see the CSS Reference Guide.
Annotations
@Override
onClearPropertyback to summary
public final ObjectProperty<Runnable> onClearProperty()

A callback that will be invoked when the user clicks on the "clear" hyperlink.

Returns:ObjectProperty<Runnable>

the "on clear" callback

See Also
clearTextProperty()
setChipsback to summary
public final void setChips(ObservableList<ChipView<?>> chips)
setClearTextback to summary
public final void setClearText(String clearText)
setOnClearback to summary
public final void setOnClear(Runnable onClear)
updateChipsback to summary
private void updateChips()