Module jpro.webapi
Package com.jpro.webapi

Class HTMLView

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
com.jpro.webapi.HTMLView
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget
public class HTMLView extends javafx.scene.layout.Region
HTMLView is a JavaFX node, which contains HTML content to be rendered in the browser by JPro. The width and height of the displayed HTML content is the width and height of the HTMLView's width and height properties. HTMLView's content is a string with HTML formatted text.

Take a look at our samples for more detailed information, on how to use HTMLView: https://github.com/JPro-one/JPro-Samples

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.BooleanProperty
    blockKeyboardInput
    Whether the JPro application will get keyboard events.
    javafx.beans.property.BooleanProperty
    blockMouseInput
    Whether the JPro application will get mouse events.
    javafx.beans.property.StringProperty
    content
    Defines the content of the HTMLView, as an HTML formatted text.

    Properties inherited from class javafx.scene.layout.Region

    background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

    Properties inherited from class javafx.scene.Parent

    needsLayout

    Properties inherited from class javafx.scene.Node

    accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, viewOrder, visible

  • Field Summary

    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
    Description
    HTMLView()
    Creates an empty instance of the HTMLView, an instance with no content.
    HTMLView(String content)
    Creates a new instance of HTMLView, with the content provided.

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.BooleanProperty
    blockKeyboardInputProperty()
    Whether the JPro application will get keyboard events.
    javafx.beans.property.BooleanProperty
    blockMouseInputProperty()
    Whether the JPro application will get mouse events.
    javafx.beans.property.StringProperty
    contentProperty()
    Defines the content of the HTMLView, as an HTML formatted text.
    String
    getContent()
    Gets the value of the property content (a string in HTML format).
    boolean
    isBlockKeyboardInput()
    Gets the value of the property blockKeyboardInput.
    boolean
    isBlockMouseInput()
    Gets the value of the property blockMouseInput.
    void
    setBlockKeyboardInput(boolean blockKeyboardInput)
    Sets the value of the blockKeyboardInput property.
    void
    setBlockMouseInput(boolean blockMouseInput)
    Sets the value of the property blockMouseInput.
    void
    setContent(String content)
    Sets the value of the property content (a string in HTML format).

    Methods inherited from class javafx.scene.layout.Region

    backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getBaselineOffset, getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, 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, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, getInitialFocusTraversable, 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, getViewOrder, hasProperties, hoverProperty, idProperty, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

    • content

      public javafx.beans.property.StringProperty contentProperty
      Defines the content of the HTMLView, as an HTML formatted text.
      See Also:

    • blockMouseInput

      public javafx.beans.property.BooleanProperty blockMouseInputProperty
      Whether the JPro application will get mouse events. The value of this property is true if the JPro application won't get mouse events, when the HTMLView is the target in the JS event. The default value is false.
      See Also:

    • blockKeyboardInput

      public javafx.beans.property.BooleanProperty blockKeyboardInputProperty
      Whether the JPro application will get keyboard events. The value of this property is true if the JPro application won't get keyboard events, when the HTMLView is the target in the JS event. The default value is false.
      See Also:

  • Constructor Details

    • HTMLView

      public HTMLView()
      Creates an empty instance of the HTMLView, an instance with no content.

    • HTMLView

      public HTMLView(String content)
      Creates a new instance of HTMLView, with the content provided.
      Parameters:
      content - the new content, in HTML format

  • Method Details

    • contentProperty

      public javafx.beans.property.StringProperty contentProperty()
      Defines the content of the HTMLView, as an HTML formatted text.
      See Also:

    • setContent

      public void setContent(String content)
      Sets the value of the property content (a string in HTML format).
      Parameters:
      content - sets the value of the property content

    • getContent

      public String getContent()
      Gets the value of the property content (a string in HTML format).
      Returns:
      the HTML content as a string.

    • blockMouseInputProperty

      public javafx.beans.property.BooleanProperty blockMouseInputProperty()
      Whether the JPro application will get mouse events. The value of this property is true if the JPro application won't get mouse events, when the HTMLView is the target in the JS event. The default value is false.
      See Also:

    • setBlockMouseInput

      public void setBlockMouseInput(boolean blockMouseInput)
      Sets the value of the property blockMouseInput.
      Parameters:
      blockMouseInput - the value of the property blockMouseInput

    • isBlockMouseInput

      public boolean isBlockMouseInput()
      Gets the value of the property blockMouseInput.
      Returns:
      true if the JPro application won't get mouse events, when the HTMLView is the target in the JS event, otherwise false

    • blockKeyboardInputProperty

      public javafx.beans.property.BooleanProperty blockKeyboardInputProperty()
      Whether the JPro application will get keyboard events. The value of this property is true if the JPro application won't get keyboard events, when the HTMLView is the target in the JS event. The default value is false.
      See Also:

    • setBlockKeyboardInput

      public void setBlockKeyboardInput(boolean blockKeyboardInput)
      Sets the value of the blockKeyboardInput property.
      Parameters:
      blockKeyboardInput - the value of the property blockKeyboardInput

    • isBlockKeyboardInput

      public boolean isBlockKeyboardInput()
      Gets the value of the property blockKeyboardInput.
      Returns:
      true if the JPro application won't get keyboard events, when the HTMLView is the target in the JS event, otherwise false