FAQ JavaFXConsultez toutes les FAQ

Certains nœuds (ex. : les contrôles de saisie de texte) disposent de méthodes prêtes à l'emploi qui permettent de copier et de coller du texte en provenance ou à destination du presse-papier système. Il est cependant possible de récupérer une référence permettant de manipuler directement le presse-papier en invoquant la méthode statique getSystemClipboard() de la classe javafx.scene.input.Clipboard.

Par exemple :

final Clipboard clipboard = Clipboard.getSystemClipboard();

Pour placer des données sur le presse-papier, vous devez fournir un objet de type Map<javafx.scene.input.DataFormat, Object> en paramètre de la méthode setContent() de l'instance du presse-papier que vous manipulez.

En effet, lorsque vous chargez des données sur le presse-papier, nous ne chargez pas forcement une simple chaine de texte. Vous allez charger des données sous plusieurs représentations exhaustives.

Imaginons que nous voulons charger une image dans le presse-papier. Il est possible de représenter cette donnée sous plusieurs formes :

• une chaine de caractères décrivant une image - cette information sera utilisée par les logiciels qui ne supportent pas les images (ex. : un éditeur de texte non riche, liseuse pour aveugle) ;
• l'image elle-même - qui peut dans ce cas être directement collée dans les logiciels qui le supportent (ex. : un éditeur de texte riche, un logiciel de dessin) ;
• le fichier dans lequel l'image est stockée - ce qui permettrait de créer un lien vers ce fichier dans un document ;
• N'importe quel autre type d'information qui peut intéresser une sous-partie de notre programme ou un programme externe avec lequel on souhaiterait s'interfacer.
  

1
2
3
final Map<DataFormat, Object> content = new Hashmap<>(); 
[...] 
clipboard.setContent(content);

1
2
3
final ClipboardContent content = new ClipboardContent(); 
[...] 
clipboard.setContent(content);

Si vous utilisez une simple Map<DataFormat, Object>, il vous suffit d'utiliser sa méthode put() avec le type de donnée approprié.

Par exemple :

1
2
content.put(DataFormat.PLAIN_TEXT, "Salut le monde !"); 
content.put(DataFormat.IMAGE, monImage);

• putFiles() - permet de spécifier une instance de List<File> ;
• putFilesByPath() - permet de spécifier une instance de List<String> (des chemins d’accès vers des fichiers) ;
• putHtml() - permet de spécifier une chaine de caractères au format HTML ;
• putImage() - permet de spécifier une instance de la classe javafx.scene.image.Image ;
• putRtf() - permet de spécifier une chaine de caractères au formant RTF ;
• putString() - permet de spécifier une chaine de caractères ;
• putUrl() - permet de spécifier une chaine de caractères contenant une URL.
  

1
2
content.putString("Salut le monde !"); 
content.putImage(monImage);

content.putIfAbsent(DataFormat.PLAIN_TEXT, "Salut le monde !");

La classe javafx.scene.input.DataFormat fournit plusieurs types prêts à l'emploi pour l'utilisation de chaines de caractères, d'images, etc. Ces types sont définis en tant que variables statiques dans la classe :

• DataFormat.FILES - permet de spécifier une liste de fichier ;
• DataFormat.HTML - permet de spécifier une chaine de caractères au format HTML ;
• DataFormat.IMAGE - permet de spécifier une image ;
• DataFormat.PLAIN_TEXT - permet de spécifier une chaine de caractères ;
• DataFormat.RTF - permet de spécifier une chaine de caractères au format RTF ;
• DataFormat.URL - permet de spécifier une chaine de caractères contenant une URL.
  

final DataFormat fmt = new DataFormat("text/foo", "text/bar");

Pour savoir si un type de données existe déjà, il suffit d'invoquer la méthode lookupMimeType() de la classe DataFormat. Cette méthode retourne le type enregistré s'il existe, sinon elle retournera la valeur null.

Par exemple :

final DataFormat fmt = DataFormat.lookupMimeType("text/foo");

Pour savoir quels sont les types des données contenues dans le presse-papier, il suffit d'invoquer la méthode getContentTypes() de l'objet de type Clipboard. Cette méthode retourne une instance de Set<DataFormat> qui contient tous les types des données actuellement disponibles dans le presse-papier.

Par exemple :

final Set<DataFormat> available = clipboard.getContentTypes();

1
2
3
if (clipboard.hasContent(DataFormat.RTF)) { 
   [...] 
}

Pour récupérer le contenu du presse-papier, il suffit d'invoquer la méthode getContent() de la classe Clipboard en lui passant en paramètre le type de donnée approprié.

Par exemple :

final Image monImage = clipboard.getContent(DataFormat.IMAGE);

• getFiles() - retourne une List<File> ;
• getHtml() - retourne une chaine de caractères au format HTML ;
• getImage() - retourne une instance de la classe javafx.scene.image.Image ;
• getRtf() - retourne une chaine de caractères au format RTF ;
• getString() - retourne une chaine de caractères ;
• getUrl() - retourne une chaine de caractères contenant une URL.
  

final Image monImage = clipboard.getImage();

L'API Clipboard n'offre pas le moyen de placer un écouteur qui permettrait de surveiller les changements d’état et de contenu du presse-papier, de manière à activer ou désactiver un bouton (ou un menu ou menu contextuel) « Coller ». Il est cependant assez facile de créer un framework similaire à ce que nous venons de décrire.

Commençons par créer notre bouton :

1
2
3
4
5
final Button pasteButton = new Button("Coller"); 
pasteButton.setOnAction(actionEvent -> { 
    final Clipboard clipboard = Clipboard.getSystemClipboard(); 
    System.out.printf("Contenu du presse-papier \"%s\"", clipboard.getString()).println(); 
});

final BooleanProperty clipBoardContentValid = new SimpleBooleanProperty(false);

pasteButton.disableProperty().bind(clipBoardContentValid.not());

1
2
3
4
5
6
final Duration pauseWaitTime = Duration.millis(750); 
final PauseTransition pauseTransition = new PauseTransition(pauseWaitTime); 
pauseTransition.setOnFinished(actionEvent -> { 
    final Clipboard clipboard = Clipboard.getSystemClipboard(); 
    clipBoardContentValid.set(clipboard.hasString() && !clipboard.getString().trim().isEmpty()); 
});

1
2
3
final SequentialTransition waitTimer = new SequentialTransition(pauseTransition); 
waitTimer.setCycleCount(SequentialTransition.INDEFINITE); 
waitTimer.play();