nextapp.echo2.webcontainer.resource.js.TextComponent.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
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
/*
* 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 EchoTextComponent
/**
* Object/namespace for Text Component support.
* This object/namespace should not be used externally.
*/
EchoTextComponent = Core.extend({
$static: {
/**
* Returns the TextComponent data object instance based on the root element id
* of the TextComponent.
*
* @param element the root element or element id of the TextComponent
* @return the relevant TextComponent instance
*/
getComponent: function(element) {
return EchoDomPropertyStore.getPropertyValue(element, "component");
},
/**
* Processes a focus blur event:
* Records the current state of the text field to the ClientMessage.
* Delegates to data object method.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processBlur: function(echoEvent) {
var textComponent = EchoTextComponent.getComponent(echoEvent.registeredTarget);
textComponent.processBlur(echoEvent);
},
/**
* Processes a text change event:
* Records the current state of the text field to the ClientMessage.
* Delegates to data object method.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processChange: function(echoEvent) {
var textComponent = EchoTextComponent.getComponent(echoEvent.registeredTarget);
textComponent.processChange(echoEvent);
},
/**
* Processes a focus event:
* Notes focus state in ClientMessage.
* Delegates to data object method.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processFocus: function(echoEvent) {
var textComponent = EchoTextComponent.getComponent(echoEvent.registeredTarget);
textComponent.processFocus(echoEvent);
},
/**
* Processes a key press event:
* Initiates an action in the event that the key pressed was the
* ENTER key.
* Delegates to data object method.
*
* @param e the DOM Level 2 event, if available
*/
processKeyPress: function(e) {
e = e ? e : window.event;
var target = EchoDomUtil.getEventTarget(e);
var textComponent = EchoTextComponent.getComponent(target);
textComponent.processKeyPress(e);
},
/**
* Processes a key up event:
* Records the current state of the text field to the ClientMessage.
* Delegates to data object method.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processKeyUp: function(echoEvent) {
var textComponent = EchoTextComponent.getComponent(echoEvent.registeredTarget);
textComponent.processKeyUp(echoEvent);
}
},
/**
* Creates a new text component support object.
*
* @param elementId the id of the supported text component element
*/
$construct: function(elementId) {
this.elementId = elementId;
},
/**
* Disposes of resources used by the support object.
*/
dispose: function() {
var element = this.getElement();
EchoEventProcessor.removeHandler(element, "mouseout");
EchoEventProcessor.removeHandler(element, "blur");
EchoEventProcessor.removeHandler(element, "focus");
EchoEventProcessor.removeHandler(element, "keyup");
EchoDomUtil.removeEventListener(element, "keypress", EchoTextComponent.processKeyPress, false);
// Remove any updates to text component that occurred during client/server transaction.
EchoClientMessage.removePropertyElement(element.id, "text");
EchoDomPropertyStore.dispose(element);
},
/**
* Processes a user "action request" on the text component i.e., the pressing
* of the ENTER key when the the component is focused.
* If any server-side ActionListeners are registered, an action
* will be set in the ClientMessage and a client-server connection initiated.
*/
doAction: function() {
if (!this.serverNotify) {
return;
}
if (!this.enabled || !EchoClientEngine.verifyInput(this.getElement(), false)) {
// Don't process actions when client/server transaction in progress.
return;
}
this.updateClientMessage();
EchoClientMessage.setActionValue(this.elementId, "action");
EchoServerTransaction.connect();
},
/**
* Returns the text component's DOM element.
*/
getElement: function() {
return document.getElementById(this.elementId);
},
/**
* Initializes the text component support object.
*/
init: function() {
var element = this.getElement();
if (!this.enabled) {
element.readOnly = true;
}
if (this.text) {
element.value = this.text;
}
if (this.horizontalScroll !== 0) {
element.scrollLeft = this.horizontalScroll;
}
this.multipleLines = element.nodeName.toLowerCase() != "input";
if (this.verticalScroll !== 0) {
if (EchoClientProperties.get("quirkIERepaint")) {
// Avoid IE quirk where browser will fail to set scroll bar position.
var originalWidth = element.style.width;
var temporaryWidth = parseInt(element.clientWidth, 10) - 1;
element.style.width = temporaryWidth + "px";
element.style.width = originalWidth;
}
element.scrollTop = this.verticalScroll;
}
if (EchoClientProperties.get("quirkMozillaTextInputRepaint")) {
// Avoid Mozilla quirk where text will be rendered outside of text field
// (this appears to be a Mozilla bug).
var noValue = !element.value;
if (noValue) {
element.value = "-";
}
var currentWidth = element.style.width;
element.style.width = "20px";
element.style.width = currentWidth;
if (noValue) {
element.value = "";
}
}
EchoEventProcessor.addHandler(element, "mouseout", "EchoTextComponent.processChange");
EchoEventProcessor.addHandler(element, "blur", "EchoTextComponent.processBlur");
EchoEventProcessor.addHandler(element, "focus", "EchoTextComponent.processFocus");
EchoEventProcessor.addHandler(element, "keyup", "EchoTextComponent.processKeyUp");
EchoDomUtil.addEventListener(element, "keypress", EchoTextComponent.processKeyPress, false);
EchoDomPropertyStore.setPropertyValue(element, "component", this);
},
/**
* Processes a focus blur event:
* Records the current state of the text field to the ClientMessage.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processBlur: function(echoEvent) {
if (!this.enabled || !EchoClientEngine.verifyInput(this.getElement())) {
return;
}
this.updateClientMessage();
EchoFocusManager.setFocusedState(this.elementId, false);
},
/**
* Processes a text change event.
* Records the current state of the text field to the ClientMessage.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processChange: function(echoEvent) {
if (!this.enabled || !EchoClientEngine.verifyInput(this.getElement())) {
return;
}
this.updateClientMessage();
},
/**
* Processes a focus event:
* Notes focus state in ClientMessage.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processFocus: function(echoEvent) {
if (!this.enabled || !EchoClientEngine.verifyInput(this.getElement())) {
return;
}
EchoFocusManager.setFocusedState(this.elementId, true);
},
/**
* Processes a key press event:
* Initiates an action in the event that the key pressed was the
* ENTER key.
*
* @param e the DOM Level 2 event
*/
processKeyPress: function(e) {
if (!this.enabled || !EchoClientEngine.verifyInput(this.getElement(), true)) {
EchoDomUtil.preventEventDefault(e);
return;
}
if (e.keyCode == 13) {
if (!this.multipleLines) {
EchoDomUtil.preventEventDefault(e);
}
this.doAction();
}
},
/**
* Processes a key up event:
* Records the current state of the text field to the ClientMessage.
*
* @param echoEvent the event, preprocessed by the
* EchoEventProcessor
*/
processKeyUp: function(echoEvent) {
var element = this.getElement();
if (!this.enabled || !EchoClientEngine.verifyInput(element, true)) {
EchoDomUtil.preventEventDefault(echoEvent);
return;
}
if (this.maximumLength >= 0) {
if (element.value && element.value.length > this.maximumLength) {
element.value = element.value.substring(0, this.maximumLength);
}
}
this.updateClientMessage();
},
/**
* Updates the component state in the outgoing ClientMessage.
*/
updateClientMessage: function() {
var element = this.getElement();
var textPropertyElement = EchoClientMessage.createPropertyElement(this.elementId, "text");
if (textPropertyElement.firstChild) {
textPropertyElement.firstChild.nodeValue = element.value;
} else {
textPropertyElement.appendChild(EchoClientMessage.messageDocument.createTextNode(element.value));
}
EchoClientMessage.setPropertyValue(this.elementId, "horizontalScroll", element.scrollLeft);
EchoClientMessage.setPropertyValue(this.elementId, "verticalScroll", element.scrollTop);
}
});
/**
* Static object/namespace for Text Component MessageProcessor
* implementation.
*/
EchoTextComponent.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":
EchoTextComponent.MessageProcessor.processInit(messagePartElement.childNodes[i]);
break;
case "dispose":
EchoTextComponent.MessageProcessor.processDispose(messagePartElement.childNodes[i]);
break;
case "set-text":
EchoTextComponent.MessageProcessor.processSetText(messagePartElement.childNodes[i]);
break;
}
}
}
},
/**
* Processes a dispose message to finalize the state of a
* Text 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 textComponent = EchoTextComponent.getComponent(elementId);
if (textComponent) {
textComponent.dispose();
}
}
},
/**
* Processes a set-text message to update the text displayed in a
* Text Component.
*
* @param setTextMessageElement the set-text element to process
*/
processSetText: function(setTextMessageElement) {
for (var item = setTextMessageElement.firstChild; item; item = item.nextSibling) {
var elementId = item.getAttribute("eid");
var text = item.getAttribute("text");
var textComponent = document.getElementById(elementId);
textComponent.value = text;
// Remove any updates to text component that occurred during client/server transaction.
EchoClientMessage.removePropertyElement(textComponent.id, "text");
}
},
/**
* Processes an init message to initialize the state of a
* Text 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 textComponent = new EchoTextComponent(elementId);
textComponent.enabled = item.getAttribute("enabled") != "false";
textComponent.text = item.getAttribute("text") ? item.getAttribute("text") : null;
textComponent.serverNotify = item.getAttribute("server-notify") == "true";
textComponent.maximumLength = item.getAttribute("maximum-length") ? item.getAttribute("maximum-length") : -1;
textComponent.horizontalScroll = item.getAttribute("horizontal-scroll") ?
parseInt(item.getAttribute("horizontal-scroll"), 10) : 0;
textComponent.verticalScroll = item.getAttribute("vertical-scroll") ?
parseInt(item.getAttribute("vertical-scroll"), 10) : 0;
textComponent.init();
}
}
};
© 2015 - 2025 Weber Informatics LLC | Privacy Policy