1 /*
   2  * Copyright (c) 2004, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package sun.swing;
  27 
  28 import java.awt.Color;
  29 import javax.swing.plaf.ColorUIResource;
  30 
  31 /**
  32  * A subclass of ColorUIResource that wraps an alternate color
  33  * for use during printing. Useful to replace color values that
  34  * may look poor in printed output.
  35  *
  36  * @author Shannon Hickey
  37  *
  38  */
  39 @SuppressWarnings("serial") // JDK-implementation class
  40 public class PrintColorUIResource extends ColorUIResource {
  41 
  42     /** The color to use during printing */
  43     private Color printColor;
  44 
  45     /**
  46      * Construct an instance for the given RGB value and
  47      * alternate color to use during printing.
  48      *
  49      * @param rgb the color rgb value
  50      * @param printColor the alternate color for printing
  51      */
  52     public PrintColorUIResource(int rgb, Color printColor) {
  53         super(rgb);
  54         this.printColor = printColor;
  55     }
  56 
  57     /**
  58      * Return the color to use during printing. If no alternate
  59      * color was specified on construction, this method will
  60      * return <code>this</code>.
  61      *
  62      * @return the color to use during printing
  63      */
  64     public Color getPrintColor() {
  65         return ((printColor != null) ? printColor : this);
  66     }
  67 
  68     /**
  69      * Replaces this object with a plain {@code ColorUIResource} during
  70      * serialization. Since {@code PrintColorUIResource} resides in the
  71      * sun.swing package, access can be disallowed to it by a security
  72      * manager. When access is disallowed, deserialization of any object
  73      * with reference to a {@code PrintColorUIResource} fails.
  74      * <p>
  75      * Since {@code PrintColorUIResource} is used only by Swing's look
  76      * and feels, and we know that UI supplied colors are replaced after
  77      * deserialization when the UI is re-installed, the only important
  78      * aspect of the {@code PrintColorUIResource} that needs to be
  79      * persisted is the fact that it is a {@code ColorUIResource}. As
  80      * such, we can avoid the problem outlined above by replacing
  81      * the problematic {@code PrintColorUIResource} with a plain
  82      * {@code ColorUIResource}.
  83      * <p>
  84      * Note: As a result of this method, it is not possible to write
  85      * a {@code PrintColorUIResource} to a stream and then read
  86      * back a {@code PrintColorUIResource}. This is acceptable since we
  87      * don't have a requirement for that in Swing.
  88      */
  89     private Object writeReplace() {
  90         return new ColorUIResource(this);
  91     }
  92 }