The clip shape determines whether the control will clip the photo via a circle or a rectangle shape.

Returns:ObjectProperty<PhotoView.ClipShape>

the clip shape (circle, rectangle)

Specifies whether the view should constantly create a cropped image version of the original image whenever the user edits the original. Creating a cropped image can have a performance impact on slower hardware (e.g. embedded).

Returns:BooleanProperty

true if the view should create the cropped image

See Also

croppedImageProperty()

A read-only property that contains the cropped version of the original image. An image becomes cropped when the user moves it around or zooms into it. The cropped image is a good candidate for saving it to the server or database. However, applications can choose freely whether they prefer to store the original image or not.

Returns:ReadOnlyObjectProperty<Image>

the cropped image version of the original image

Controls whether the user will be able to edit the photo / image. If editable the control will display a slider below the photo for zooming. The user will also be able to zoom in via pinch zoom or scroll wheel. Via mouse dragging the user can move the photo around.

Returns:BooleanProperty

"true" if the view is editable

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);
    }
}

Annotations

@Override

Stores the maximum amount that the user will be allowed to zoom into the view. The default value is 5.

Returns:DoubleProperty

the maximum zoom value (default 5)

An effect that will be applied to the image, not the whole control. Applications could for example apply a sepia effect (see SepiaTone).

Returns:ObjectProperty<Effect>

the photo effect

Stores the original photo.

Returns:ObjectProperty<Image>

the photo

The photo supplier will be invoked when the user clicks on the control (or hits space oder enter keys). The default photo supplier registered on the control will bring up a file chooser so that the user can select the image file.

Returns:ObjectProperty<Supplier<Image>>

the photo supplier

Stores the percentage-based amount of the horizontal translation. We can not use pixel-based translation as the view might change its size. This value changes when the user drags the photo left or right.

Returns:DoubleProperty

the translate x value (in percent)

Stores the percentage-based amount of the vertical translation. We can not use pixel-based translation as the view might change its size. This value changes when the user drags the photo up or down.

Returns:DoubleProperty

the translate y value (in percent)

The zoom applied to the photo so that the photo's content fills out the view as good as possible.

Returns:DoubleProperty

the photo zoom

A placeholder that will be shown when no photo / image has been specified. The default placeholder prompts the user to "click to add or drop a file".

Returns:ObjectProperty<Node>

the placeholder node