View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.composer.layout;
23  
24  import static org.opencastproject.util.EqualsUtil.eq;
25  import static org.opencastproject.util.EqualsUtil.hash;
26  
27  /**
28   * This layout specification describes where to position a shape in relation to another.
29   * <p>
30   * In contrast to the {@link HorizontalCoverageLayoutSpec} this spec does not scale any shape.
31   */
32  public final class AbsolutePositionLayoutSpec {
33    private final AnchorOffset anchorOffset;
34  
35    /**
36     * Create a new specification.
37     *
38     * @param anchorOffset
39     *          The distance of the anchor points of canvas and shape. The canvas is the "reference", the shape the
40     *          "referring" part of the distance object.
41     */
42    public AbsolutePositionLayoutSpec(AnchorOffset anchorOffset) {
43      this.anchorOffset = anchorOffset;
44    }
45  
46    /** Get the distance between the anchor points of canvas and shape. */
47    public AnchorOffset getAnchorOffset() {
48      return anchorOffset;
49    }
50  
51    @Override
52    public boolean equals(Object that) {
53      return (this == that)
54              || (that instanceof AbsolutePositionLayoutSpec && eqFields((AbsolutePositionLayoutSpec) that));
55    }
56  
57    private boolean eqFields(AbsolutePositionLayoutSpec that) {
58      return eq(anchorOffset, that.anchorOffset);
59    }
60  
61    @Override
62    public int hashCode() {
63      return hash(anchorOffset);
64    }
65  }