Canvas.java

/*
Copyright 2008-2012 Opera Software ASA

Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package com.opera.core.systems.model;

/**
 * A canvas object to use in taking screenshots of Opera's viewport.  The screenshot can be relative
 * to viewport or to the window.
 */
public class Canvas {

  private int x = 0;
  private int y = 0;
  private int width = 0;
  private int height = 0;

  private boolean viewPortRelative = false;

  public Canvas() {
  }

  public Canvas(int x, int y, int width, int height) {
    this.x = x;
    this.y = y;
    this.width = width;
    this.height = height;
  }

  public boolean isViewPortRelative() {
    return viewPortRelative;
  }

  /**
   * Sets the screenshots to be relative to screen or to window, default is window.
   *
   * @param viewPortRelative true if relative to window
   */
  public void setViewPortRelative(boolean viewPortRelative) {
    this.viewPortRelative = viewPortRelative;
  }

  public int getX() {
    return x;
  }

  public void setX(int x) {
    this.x = x;
  }

  public int getY() {
    return y;
  }

  public void setY(int y) {
    this.y = y;
  }

  public int getWidth() {
    return width;
  }

  public void setWidth(int width) {
    this.width = width;
  }

  public int getHeight() {
    return height;
  }

  public void setHeight(int height) {
    this.height = height;
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == null || !(obj instanceof Canvas)) {
      return false;
    }

    Canvas canvas = (Canvas) obj;
    return getX() == canvas.getX() && getY() == canvas.getY() &&
           getHeight() == canvas.getHeight() && getWidth() == canvas.getWidth() &&
           isViewPortRelative() == canvas.isViewPortRelative();
  }

  @Override
  public int hashCode() {
    return super.hashCode();
  }

  @Override
  public String toString() {
    return String.format("Canvas [x=%d, y=%d, width=%d, height=%d, viewPortRelative=%s]",
                         x, y, width, height, viewPortRelative);
  }

}