com.gluonhq.charm.glisten.mvc

Class View

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.BorderPane

com.gluonhq.charm.glisten.layout.MobileLayoutPane

com.gluonhq.charm.glisten.mvc.View

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget

public class View
extends MobileLayoutPane

Glisten user interfaces are built using views, which are essentially named MobileLayoutPanes. To construct a View instance, a developer simply calls the constructor and then begins to use the API inherited from MobileLayoutPane, most notably BorderPane.setTop(Node), BorderPane.setCenter(Node), and BorderPane.setBottom(Node).

Layers can be placed on top of a View by adding them to the layers list. By doing this, it is possible to present popup cards and other context-specific information to users.

See Also:

Layer

Property Summary

Type	Property and Description
javafx.beans.property.StringProperty	name The name of this View - this is very important as it is the means through which this View is differentiated from all other Views in API on MobileApplication.
javafx.beans.property.ReadOnlyBooleanProperty	showing A boolean property used to represent whether this View is currently being shown on screen.
javafx.beans.property.ObjectProperty<Swatch>	swatch Specifies the Swatch that should be used when this View is shown.

Properties inherited from class javafx.scene.layout.BorderPane

bottomProperty, centerProperty, leftProperty, rightProperty, topProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.event.EventType<javafx.event.Event>	ON_DESTROY Called when the view has been destroyed.
static javafx.event.EventType<javafx.event.Event>	ON_HIDDEN Called when the view has been hidden.
static javafx.event.EventType<javafx.event.Event>	ON_INIT Called when the view has been initialized, but not yet shown.
static javafx.event.EventType<javafx.event.Event>	ON_SHOWN Called when the view has been shown.

Fields inherited from class com.gluonhq.charm.glisten.layout.MobileLayoutPane

DEFAULT_ANIMATION_DURATION, DEFAULT_BACKGROUND_FADE_LEVEL

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
View(javafx.scene.Node content) Creates a new View instance with the given content and a null name.
View(java.lang.String name) Creates a new View instance with the given name.
View(java.lang.String name, javafx.scene.Node content) Creates a new View instance with the given name and content.

Method Summary

Modifier and Type	Method and Description
MobileApplication	getApplication() Convenience method that returns the MobileApplication instance that this View finds itself contained within.
java.lang.String	getName() Gets the value of the property name.
Swatch	getSwatch() Gets the value of the property swatch.
void	hide() This will hide this View if it is currently showing, returning to the previous view or the home view, depending on the state of the application.
boolean	isShowing() Gets the value of the property showing.
javafx.beans.property.StringProperty	nameProperty() The name of this View - this is very important as it is the means through which this View is differentiated from all other Views in API on MobileApplication.
void	setName(java.lang.String value) Sets the value of the property name.
void	setSwatch(Swatch swatch) Sets the value of the property swatch.
void	show() Assuming that the name of this View is not null and not empty, calling this method will result in the application switching out the currently displayed view, and showing this view in its place.
javafx.beans.property.ReadOnlyBooleanProperty	showingProperty() A boolean property used to represent whether this View is currently being shown on screen.
javafx.beans.property.ObjectProperty<Swatch>	swatchProperty() Specifies the Swatch that should be used when this View is shown.

Methods inherited from class com.gluonhq.charm.glisten.layout.MobileLayoutPane

getLayers, layoutChildren

Methods inherited from class javafx.scene.layout.BorderPane

bottomProperty, centerProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getBottom, getCenter, getContentBias, getLeft, getMargin, getRight, getTop, leftProperty, rightProperty, setAlignment, setBottom, setCenter, setLeft, setMargin, setRight, setTop, topProperty

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

showing

public final javafx.beans.property.ReadOnlyBooleanProperty showingProperty

A boolean property used to represent whether this View is currently being shown on screen.

See Also:

isShowing()

name

public final javafx.beans.property.StringProperty nameProperty

The name of this View - this is very important as it is the means through which this View is differentiated from all other Views in API on MobileApplication. Ideally, the name would be set in the View constructor, and never changed, although at present this is not enforced.

See Also:

getName(), setName(String)

swatch

public final javafx.beans.property.ObjectProperty<Swatch> swatchProperty

Specifies the Swatch that should be used when this View is shown. Whenever this view is shown, the swatch will be automatically set. A value of null in this property will indicate to Glisten that no swatch changing should occur, keeping the currently installed swatch.

See Also:

getSwatch(), setSwatch(Swatch)

Field Detail

ON_SHOWN

public static final javafx.event.EventType<javafx.event.Event> ON_SHOWN

Called when the view has been shown.

ON_HIDDEN

public static final javafx.event.EventType<javafx.event.Event> ON_HIDDEN

Called when the view has been hidden.

ON_INIT

public static final javafx.event.EventType<javafx.event.Event> ON_INIT

Called when the view has been initialized, but not yet shown.

ON_DESTROY

public static final javafx.event.EventType<javafx.event.Event> ON_DESTROY

Called when the view has been destroyed.

Constructor Detail

View

public View(java.lang.String name)

Creates a new View instance with the given name.

View

public View(javafx.scene.Node content)

Creates a new View instance with the given content and a null name.

View

public View(java.lang.String name,
            javafx.scene.Node content)

Creates a new View instance with the given name and content.

Method Detail

showingProperty

public final javafx.beans.property.ReadOnlyBooleanProperty showingProperty()

A boolean property used to represent whether this View is currently being shown on screen.

See Also:

isShowing()

isShowing

public final boolean isShowing()

Gets the value of the property showing.

nameProperty

public final javafx.beans.property.StringProperty nameProperty()

The name of this View - this is very important as it is the means through which this View is differentiated from all other Views in API on MobileApplication. Ideally, the name would be set in the View constructor, and never changed, although at present this is not enforced.

See Also:

getName(), setName(String)

getName

public final java.lang.String getName()

Gets the value of the property name.

setName

public final void setName(java.lang.String value)

Sets the value of the property name.

swatchProperty

public final javafx.beans.property.ObjectProperty<Swatch> swatchProperty()

Specifies the Swatch that should be used when this View is shown. Whenever this view is shown, the swatch will be automatically set. A value of null in this property will indicate to Glisten that no swatch changing should occur, keeping the currently installed swatch.

See Also:

getSwatch(), setSwatch(Swatch)

getSwatch

public final Swatch getSwatch()

Gets the value of the property swatch.

setSwatch

public final void setSwatch(Swatch swatch)

Sets the value of the property swatch.

show

public final void show()

Assuming that the name of this View is not null and not empty, calling this method will result in the application switching out the currently displayed view, and showing this view in its place. This is equivalent to calling MobileApplication.setView(View).

hide

public final void hide()

This will hide this View if it is currently showing, returning to the previous view or the home view, depending on the state of the application.

getApplication

public final MobileApplication getApplication()

Convenience method that returns the MobileApplication instance that this View finds itself contained within.