Shadow.java

/*
 Copyright (c) 2014 Ahomé Innovation Technologies. All rights reserved.

 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.ait.toolkit.sencha.ext.client.ui;

import com.ait.toolkit.sencha.ext.client.core.BaseExtWidget;
import com.ait.toolkit.core.client.JsoHelper;
import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.dom.client.Element;

/**
 * Simple class that can provide a shadow effect for any element. Note that the
 * element MUST be absolutely positioned, and the shadow does not provide any
 * shimming. This should be used only in simple cases -- for more advanced
 * functionality that can also provide the same shadow effect, see the
 * {@link Layer} class.
 */
public class Shadow extends BaseExtWidget {

    /**
     * Shadow on sides (default)
     */
    public static Type SIDES = new Type("sides");

    /**
     * For 4-way shadow
     */
    public static Type FRAME = new Type("frame");

    /**
     * Shadow on bottom right.
     */
    public static Type DROP = new Type("drop");

    /**
     * Create a new Shadow.
     * 
     * @param mode
     *            The shadow display mode. Supports the following options:
     *            sides: Shadow displays on both sides and bottom only, frame:
     *            Shadow displays equally on all four sides, drop: Traditional
     *            bottom-right drop shadow (default)
     * @param offset
     *            the number of pixels to offset the shadow from the element
     *            (defaults to 4)
     */
    public Shadow(String mode, String offset) {
        JavaScriptObject config = JsoHelper.createObject();
        JsoHelper.setAttribute(config, "mode", mode);
        JsoHelper.setAttribute(config, "offset", offset);
        jsObj = create(config);
    }

    private native JavaScriptObject create(JavaScriptObject config) /*-{
		return new $wnd.Ext.Shadow(config);
    }-*/;

    /**
     * Hides this shadow.
     */
    public native void hide() /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		shadow.hide();
    }-*/;

    /**
     * Returns true if the shadow is visible, else false.
     * 
     * @return true if shadow visible
     */
    public native boolean isVisible() /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		return shadow.isVisible();
    }-*/;

    /**
     * Direct alignment when values are already available. {@link #show} must be
     * called at least once before calling this method to ensure it is
     * initialized.
     * 
     * @param left
     *            The target element left position
     * @param top
     *            The target element top position
     * @param width
     *            The target element width
     * @param height
     *            The target element height
     */
    public native void realign(int left, int top, int width, int height) /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		shadow.realign(left, top, width, height);
    }-*/;

    /**
     * Adjust the z-index of this shadow.
     * 
     * @param zindex
     *            The new z-index
     */
    public native void setZIndex(int zindex) /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		shadow.setZIndex(zindex);
    }-*/;

    /**
     * Displays the shadow under the target element.
     * 
     * @param id
     *            the element ID
     */
    public native void show(String id) /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		shadow.show(id);
    }-*/;

    /**
     * Displays the shadow under the target element.
     * 
     * @param element
     *            the element
     */
    public native void show(Element element) /*-{
		var shadow = this.@com.ait.toolkit.sencha.ext.client.core.BaseExtWidget::jsObj;
		shadow.show(element);
    }-*/;

    public static class Type {
        private String type;

        public Type(String type) {
            this.type = type;
        }

        public String getType() {
            return type;
        }
    }
}