// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.GWT.client.widgets.nonpublic;

import org.litesoft.commonfoundation.typeutils.*;

import com.google.gwt.dom.client.*;
import com.google.gwt.user.client.*;
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.ui.*;

import static com.google.gwt.dom.client.Style.*;

public class CommonElementHelper
{
    public static final String LAYOUT_OVERFLOW_HIDDEN = "litesoft-LayoutOverflowHidden";
    public static final String LAYOUT_OVERFLOW_AUTO = "litesoft-LayoutOverflowAuto";

    public static String determineOverflowClass( boolean pHidden )
    {
        return pHidden ? LAYOUT_OVERFLOW_HIDDEN : LAYOUT_OVERFLOW_AUTO;
    }

    public static Element setOverflowClass( Element pElement, boolean pHidden )
    {
        return setStyleClass( pElement, determineOverflowClass( pHidden ) );
    }

    public static Element setStyleClass( Element pElement, String pStyleClassName )
    {
        if ( null != (pStyleClassName = Strings.noEmpty( pStyleClassName )) )
        {
            pElement.setClassName( pStyleClassName );
        }
        return pElement;
    }

    public static Element setTextAreaWordWrap( Element pElement, boolean pWrap )
    {
        pElement.setPropertyString( "wrap", pWrap ? "soft" : "off" );
        return setWhiteSpaceWrap( pElement, pWrap );
    }

    public static Element setWhiteSpaceWrap( Element pElement, boolean pWrap )
    {
        return setStyleProperty( pElement, "whiteSpace", pWrap ? "normal" : "nowrap" );
    }

    public static boolean isWhiteSpaceWrap( Element pElement )
    {
        return !"nowrap".equals( pElement.getPropertyString( "whiteSpace" ) );
    }

    public static Element setDisplayTableCell( Element pElement )
    {
        return setStyleProperty( pElement, "display", "table-cell" );
    }

    public static Element setPositionAbsolute( Element pElement )
    {
        pElement.getStyle().setPosition( Position.ABSOLUTE );
        return pElement;
    }

    public static Element setPositionRelative( Element pElement )
    {
        pElement.getStyle().setPosition( Position.RELATIVE );
        return pElement;
    }

    public static Element setTop( Element pElement, int pPX )
    {
        pElement.getStyle().setTop( pPX, Unit.PX );
        return pElement;
    }

    public static Element setLeft( Element pElement, int pPX )
    {
        pElement.getStyle().setLeft( pPX, Unit.PX );
        return pElement;
    }

    public static Element setHeight( Element pElement, int pPX )
    {
        pElement.getStyle().setHeight( pPX, Unit.PX );
        return pElement;
    }

    public static Element setWidth( Element pElement, int pPX )
    {
        pElement.getStyle().setWidth( pPX, Unit.PX );
        return pElement;
    }

    /**
     * @return pParent
     */
    public static Element appendChild( Element pParent, Element pChild )
    {
        DOM.appendChild( pParent, pChild );
        return pParent;
    }

    /**
     * @return pChild
     */
    public static Element appendToParent( Element pChild, Element pParent )
    {
        DOM.appendChild( pParent, pChild );
        return pChild;
    }

    /**
     * @return Div
     */
    public static Element createDiv( String pStyleClassName )
    {
        return setStyleClass( DOM.createDiv(), pStyleClassName );
    }

    /**
     * @return Table
     */
    public static Element createTable( String pStyleClassName )
    {
        return setStyleClass( createTable(), pStyleClassName );
    }

    public static Element setImgSrc( Element pImg, String pUrl )
    {
        ImageElement.as( pImg ).setSrc( pUrl );
        return pImg;
    }

    public static void setTDalign( Element pTD, HasHorizontalAlignment.HorizontalAlignmentConstant pAlign )
    {
        TableCellElement.as( pTD ).setAlign( pAlign.getTextAlignString() );
    }

    public static void setTDvAlign( Element pTD, HasVerticalAlignment.VerticalAlignmentConstant pValign )
    {
        TableCellElement.as( pTD ).setVAlign( pValign.getVerticalAlignString() );
    }

    /**
     * @return Table
     */
    public static Element createTable()
    {
        TableElement zElement = Document.get().createTableElement();
        zElement.setBorder( 0 );
        zElement.setCellSpacing( 0 );
        zElement.setCellPadding( 0 );
        return zElement.cast();
    }

    /**
     * @return TBody
     */
    public static Element finishTableNgetTBody( Element pTable )
    {
        Element rv;
        appendChild( pTable, rv = DOM.createTBody() );
        return rv;
    }

    /**
     * @return TR
     */
    public static Element finishTableNgetTR( Element pTable )
    {
        Element rv;
        appendChild( finishTableNgetTBody( pTable ), rv = DOM.createTR() );
        return rv;
    }

    /**
     * @return TD
     */
    public static Element finishTableNgetTD( Element pTable )
    {
        Element rv;
        appendChild( finishTableNgetTR( pTable ), rv = DOM.createTD() );
        return rv;
    }

    public static int getOffsetHeight( Element pElement )
    {
        return pElement.getOffsetHeight();
    }

    public static int getOffsetWidth( Element pElement )
    {
        return pElement.getOffsetWidth();
    }

    /**
     * Get the HTML tag name.
     *
     * @param element a DOM element
     *
     * @return the value of the tagName property, or null if
     *         <code>element</code> is null
     */
    public static native String getTagName( Element element ) /*-{
        return element ? element.tagName : null;
    }-*/;

    public static DIVconstrainer createDIVconstrainer()
    {
        Element zTable = createTable();
        Element zTR = finishTableNgetTR( zTable );
        Element zTD = appendToParent( DOM.createTD(), zTR );
        return new DIVconstrainer( zTable, zTD );
    }

    public static void forceNoMarginOrPadding( Element pElement )
    {
        Style zStyle = pElement.getStyle();
        zStyle.setMargin( 0, Unit.PX );
        zStyle.setPadding( 0, Unit.PX );
    }

    public static void setOverflowAuto( com.google.gwt.dom.client.Element pElement )
    {
        setOverflow( pElement, Overflow.AUTO );
    }

    public static void setOverflowVisible( com.google.gwt.dom.client.Element pElement )
    {
        setOverflow( pElement, Overflow.VISIBLE );
    }

    public static void setOverflowHidden( com.google.gwt.dom.client.Element pElement )
    {
        setOverflow( pElement, Overflow.HIDDEN );
    }

    public static void setOverflowScroll( com.google.gwt.dom.client.Element pElement )
    {
        setOverflow( pElement, Overflow.SCROLL );
    }

    private static void setOverflow( com.google.gwt.dom.client.Element pElement, Overflow pToWhat )
    {
        pElement.getStyle().setOverflow( pToWhat );
    }

    public static void hide( com.google.gwt.dom.client.Element pElement )
    {
        setHidden( pElement, true );
    }

    public static void unhide( com.google.gwt.dom.client.Element pElement )
    {
        setHidden( pElement, false );
    }

    public static void setHidden( com.google.gwt.dom.client.Element pElement, boolean pHide )
    {
        pElement.getStyle().setVisibility( pHide ? Visibility.HIDDEN : Visibility.VISIBLE );
    }

    public static boolean isHidden( com.google.gwt.dom.client.Element pElement )
    {
        return is( pElement.getStyle().getVisibility(), Visibility.HIDDEN );
    }

    public static boolean isVisible( com.google.gwt.dom.client.Element pElement )
    {
        return !is( pElement.getStyle().getDisplay(), Display.NONE );
    }

    private static boolean is( String pPropertyValue, HasCssName pExpected )
    {
        return pExpected.getCssName().equals( pPropertyValue );
    }

    private static Element setStyleProperty( Element pElement, String pProperty, String pValue )
    {
        pElement.getStyle().setProperty( pProperty, pValue );
        return pElement;
    }
}