nextapp.echo2.webcontainer.resource.js.ContentPane.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

//_______________________
// Object EchoContentPane

/**
 * Static object/namespace for ContentPane support.
 * This object/namespace should not be used externally.
 */
EchoContentPane = {
    
    /**
     * Static object/namespace for ContentPane MessageProcessor 
     * implementation.
     */
    MessageProcessor: {
    
        /**
         * MessageProcessor process() implementation 
         * (invoked by ServerMessage processor).
         *
         * @param messagePartElement the message-part element to process.
         */
        process: function(messagePartElement) {
            for (var i = 0; i < messagePartElement.childNodes.length; ++i) {
                if (messagePartElement.childNodes[i].nodeType == 1) {
                    switch (messagePartElement.childNodes[i].tagName) {
                    case "init":
                        EchoContentPane.MessageProcessor.processInit(messagePartElement.childNodes[i]);
                        break;
                    case "dispose":
                        EchoContentPane.MessageProcessor.processDispose(messagePartElement.childNodes[i]);
                        break;
                    case "scroll-horizontal":
                        EchoContentPane.MessageProcessor.processScroll(messagePartElement.childNodes[i]);
                        break;
                    case "scroll-vertical":
                        EchoContentPane.MessageProcessor.processScroll(messagePartElement.childNodes[i]);
                        break;
                    }
                }
            }
        },
        
        /**
         * Processes a dispose message to finalize the state of a
         * selection component that is being removed.
         *
         * @param disposeMessageElement the dispose element to process
         */
        processDispose: function(disposeMessageElement) {
            for (var item = disposeMessageElement.firstChild; item; item = item.nextSibling) {
                var elementId = item.getAttribute("eid");
                var divElement = document.getElementById(elementId);
                if (!divElement) {
                    continue;
                }
                var contentElement = EchoContentPane.findContentElement(divElement);
                if (!contentElement) {
                    continue;
                }
                EchoEventProcessor.removeHandler(contentElement, "scroll");
            }
        },
        
        /**
         * Processes an init message to initialize the state of a 
         * selection component that is being added.
         *
         * @param initMessageElement the init element to process
         */
        processInit: function(initMessageElement) {
            for (var item = initMessageElement.firstChild; item; item = item.nextSibling) {
                var elementId = item.getAttribute("eid");
                var divElement = document.getElementById(elementId);
                var contentElement = EchoContentPane.findContentElement(divElement);
        
                var horizontalScroll = item.getAttribute("horizontal-scroll");
                var verticalScroll = item.getAttribute("vertical-scroll");
        
                if (contentElement) {
                    EchoEventProcessor.addHandler(contentElement, "scroll", "EchoContentPane.processScroll");
                    
                    if (horizontalScroll) {
                        contentElement.scrollLeft = parseInt(horizontalScroll, 10);
                    }
                    if (verticalScroll) {
                        contentElement.scrollTop = parseInt(verticalScroll, 10);
                    }
                }
            }
        },
        
        /**
         * Processes a scroll directive to update the scrollbar positions
         * of the component.
         *
         * @param scrollMessageElement the scroll element to process
         */
        processScroll: function(scrollMessageElement) {
            var elementId = scrollMessageElement.getAttribute("eid");
            var position = parseInt(scrollMessageElement.getAttribute("position"), 10);
        
            var divElement = document.getElementById(elementId);
            var contentElement = EchoContentPane.findContentElement(divElement);
            if (!contentElement) {
                return;
            }
            
            if (position < 0) {
                position = 1000000;
            }
            
            if (scrollMessageElement.nodeName == "scroll-horizontal") {
                contentElement.scrollLeft = position;
            } else if (scrollMessageElement.nodeName == "scroll-vertical") {
                EchoDebugManager.consoleWrite("scrolling to: " + position);
                contentElement.scrollTop = position;
            }
        }
    },
        
    /**
     * Finds the content element of a ContentPane.
     * The content element is the element containing a child
     * that is NOT a FloatingPane.  (ContentPanes are limited to one
     * non-FloatingPane child).
     * 
     * @param element the root ContentPane DIV element to search.
     * @return the content DIV element, if found
     */
    findContentElement: function(element) {
        for (var child = element.firstChild; child; child = child.nextSibling) {
            if (child.id && child.id.indexOf("_content_") != -1) {
                return child;
            }
        }
        return null;
    },
    
    /**
     * Processes a scrollbar adjustment event.
     *
     * @param echoEvent the event, preprocessed by the 
     *        EchoEventProcessor
     */
    processScroll: function(echoEvent) {
        if (!EchoClientEngine.verifyInput(echoEvent.registeredTarget)) {
            return;
        }
        
        var componentId = EchoDomUtil.getComponentId(echoEvent.registeredTarget.id);
        
        EchoClientMessage.setPropertyValue(componentId, "horizontalScroll", echoEvent.registeredTarget.scrollLeft + "px");
        EchoClientMessage.setPropertyValue(componentId, "verticalScroll", echoEvent.registeredTarget.scrollTop + "px");
    }
};