001package org.gwtbootstrap3.client.ui;
002
003/*
004 * #%L
005 * GwtBootstrap3
006 * %%
007 * Copyright (C) 2013 GwtBootstrap3
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import com.google.gwt.dom.client.Element;
024import com.google.gwt.user.client.ui.UIObject;
025
026/**
027 * An Affix is an element/container that gets "pinned" as soon as a certain
028 * amount of pixels have been scrolled.
029 * <p/>
030 * Any element/container can become an Affix. Usually used for sidebar
031 * navigation.
032 * <p/>
033 * <strong>Note:</strong> Bootstrap adds/removes classes from Affix based on
034 * scroll position which requires custom styling. See Bootstrap's <a
035 * href="http://getbootstrap.com/javascript/#affix">documentation</a>.
036 *
037 * @author Sven Jacobs
038 */
039public class Affix {
040
041    /**
042     * Applys affix functionality to specified element.
043     *
044     * @param element Element to "affixnize"
045     */
046    public static void affix(final Element element) {
047        internalAffix(element, 10);
048    }
049
050    /**
051     * Applys affix functionality to specified element.
052     *
053     * @param element Element to "affixnize"
054     * @param offset  Offset of affix
055     */
056    public static void affix(final Element element, final int offset) {
057        internalAffix(element, offset);
058    }
059
060    /**
061     * Applys affix functionality to specified object.
062     *
063     * @param object Object to "affixnize"
064     */
065    public static void affix(final UIObject object) {
066        affix(object.getElement());
067    }
068
069    /**
070     * Applys affix functionality to specified object.
071     *
072     * @param object Object to "affixnize"
073     * @param offset Offset of affix
074     */
075    public static void affix(final UIObject object, final int offset) {
076        affix(object.getElement(), offset);
077    }
078
079    // @formatter:off
080
081    private static native void internalAffix(final Element e, final int offset) /*-{
082        $wnd.jQuery(e).affix({
083            offset: offset
084        });
085    }-*/;
086}