RectangleReadOnly.java

/*
 * $Id: RectangleReadOnly.java 4065 2009-09-16 23:09:11Z psoares33 $
 *
 * Copyright 1999, 2000, 2001, 2002 by Bruno Lowagie.
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the License.
 *
 * The Original Code is 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * https://github.com/LibrePDF/OpenPDF
 */

package org.openpdf.text;

import org.openpdf.text.error_messages.MessageLocalization;

/**
 * A <CODE>RectangleReadOnly</CODE> is the representation of a geometric figure. It's the same as a
 * <CODE>Rectangle</CODE> but immutable. Rectangles support constant width borders using
 * <CODE>setBorderWidth(float)</CODE> and <CODE>setBorder(int)</CODE>. They also support borders that vary in width/color on each
 * side using methods like <CODE>setBorderWidthLeft(float)</CODE> or <CODE>setBorderColorLeft(java.awt.Color)</CODE>.
 *
 * @see Element
 * @since 2.1.2
 */

public class RectangleReadOnly extends Rectangle {

    // CONSTRUCTORS

    /**
     * Constructs a <CODE>RectangleReadOnly</CODE> -object starting from the origin (0, 0).
     *
     * @param urx upper right x
     * @param ury upper right y
     */
    public RectangleReadOnly(float urx, float ury) {
        super(0, 0, urx, ury);
    }

    /**
     * Throws an error because of the read only nature of this object.
     */
    private void throwReadOnlyError() {
        throw new UnsupportedOperationException(
                MessageLocalization.getComposedMessage("rectanglereadonly.this.rectangle.is.read.only"));
    }

    // OVERWRITE METHODS SETTING THE DIMENSIONS:

    /**
     * Sets the lower left x-coordinate.
     *
     * @param llx the new value
     */
    public void setLeft(float llx) {
        throwReadOnlyError();
    }

    /**
     * Sets the upper right x-coordinate.
     *
     * @param urx the new value
     */

    public void setRight(float urx) {
        throwReadOnlyError();
    }

    /**
     * Sets the upper right y-coordinate.
     *
     * @param ury the new value
     */
    public void setTop(float ury) {
        throwReadOnlyError();
    }

    /**
     * Sets the lower left y-coordinate.
     *
     * @param lly the new value
     */
    public void setBottom(float lly) {
        throwReadOnlyError();
    }

    // OVERWRITE METHODS SETTING THE BACKGROUND COLOR:

    // OVERWRITE METHODS SETTING THE BORDER:

    // OVERWRITE METHODS SETTING THE BORDER WIDTH:

    /**
     * Sets the borderwidth of the table.
     *
     * @param borderWidth the new value
     */

    // METHODS TO GET/SET THE BORDER COLOR:

    /**
     * Sets the color of the border.
     *
     * @param borderColor a <CODE>Color</CODE>
     */

    // SPECIAL METHODS:

    /**
     * Copies each of the parameters, except the position, from a
     * <CODE>Rectangle</CODE> object
     *
     * @param rect <CODE>Rectangle</CODE> to copy from
     */
    public void cloneNonPositionParameters(Rectangle rect) {
        throwReadOnlyError();
    }

    /**
     * @return String version of the most important rectangle properties
     * @see java.lang.Object#toString()
     */
    public String toString() {
        StringBuilder buf = new StringBuilder("RectangleReadOnly: ");
        buf.append(getWidth());
        buf.append('x');
        buf.append(getHeight());
        buf.append(" (rot: ");
        buf.append(rotation);
        buf.append(" degrees)");
        return buf.toString();
    }
}