View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.devacfr.maven.skins.reflow.model;
20  
21  import javax.annotation.Nonnull;
22  
23  import org.devacfr.maven.skins.reflow.ISkinConfig;
24  
25  /**
26   * Represents the scoll top component.
27   *
28   * @author devacfr
29   * @since 2.0
30   */
31  public class ScrollTop extends Component {
32  
33      /** */
34      private final boolean smooth;
35  
36      /**
37       * Default constructor.
38       *
39       * @param config
40       *            a config (can <b>not</b> be {@code null}).
41       */
42      public ScrollTop(final @Nonnull ISkinConfig config) {
43  
44          this.smooth = config.getPropertyValue("smoothScroll", Boolean.class, true);
45          if (isSmooth()) {
46              this.addCssOptions("scrolltop-smooth-enabled");
47          }
48      }
49  
50      /**
51       * Gets the indicating whether the scrolling is smooth.
52       *
53       * @return Returns {@code true} whether the scrolling is smooth, otherwise returns {@code false}.
54       */
55      public boolean isSmooth() {
56          return smooth;
57      }
58  }