Spec-Zone .ru
спецификации, руководства, описания, API
|
001/* 002 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved. 003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 004 * 005 * This code is free software; you can redistribute it and/or modify it 006 * under the terms of the GNU General Public License version 2 only, as 007 * published by the Free Software Foundation. Oracle designates this 008 * particular file as subject to the "Classpath" exception as provided 009 * by Oracle in the LICENSE file that accompanied this code. 010 * 011 * This code is distributed in the hope that it will be useful, but WITHOUT 012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 014 * version 2 for more details (a copy is included in the LICENSE file that 015 * accompanied this code). 016 * 017 * You should have received a copy of the GNU General Public License version 018 * 2 along with this work; if not, write to the Free Software Foundation, 019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 020 * 021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 022 * or visit www.oracle.com if you need additional information or have any 023 * questions. 024 */ 025 026package javafx.scene; 027 028import javafx.scene.image.WritableImage; 029 030/** 031 * This class holds the result of a snapshot operation. 032 * @since 2.2 033 */ 034public class SnapshotResult { 035 private WritableImage image; 036 private Object source; 037 private SnapshotParameters params; 038 039 // Package scope constructor 040 SnapshotResult(WritableImage image, Object source, SnapshotParameters params) { 041 this.image = image; 042 this.source = source; 043 this.params = params; 044 } 045 046 /** 047 * Gets the image generated by the snapshot operation. 048 * 049 * @return the generated image 050 */ 051 public WritableImage getImage() { 052 return image; 053 } 054 055 /** 056 * Gets the source Node or Scene on which the snapshot was called. 057 * 058 * @return the source of the snapshot 059 */ 060 public Object getSource() { 061 return source; 062 } 063 064 /** 065 * Gets a copy of the SnapshotParameters used to generate the snapshot. 066 * This will be null in the case of snapshot being called on a Scene. 067 * 068 * @return a copy of the SnapshotParameters used to perform the snapshot, 069 * or null 070 */ 071 public SnapshotParameters getSnapshotParameters() { 072 return params; 073 } 074 075}