[NAME] Rococo.browser - indicate what platform on this script [TYPE] preset property [SYNPOSIS] Rococo.browser.agent; Rococo.browser.version; [VALUES] agent : 'op' : opera 'ie' : internet explorer 4/5/6/7 'nn' : Netscape Navigator 4 'moz' : Mozilla, FireFox, Netscape 6- 'saf' : Safari 'psp' : PlayStation Portable version : array of version string, the first is the major version. [NOTICE] version property is made from navigator.appVersion. if agent is moz or saf , version is only "5.0".
[NAME] Rococo.lang - locale setting [TYPE] property [SYNPOSIS] Rococo.lang; [VALUES] 'ja' : Japanese 'en' : English [NOTE] Rococo.lang is an only indicator. The scripts using Rococo Library must be preared multilingal texts.
[NAME] Rococo.init - array of init methods [TYPE] array [DESCRIPTION] Rococo.init is an array of functions which have no argument and are called at the time when window.onload is called. [NOTE] Rococo library overwrites window.onload. You should push functions to Rococo.init and should not overwrite window.onload. [SEE ALSO] Rococo.ut.hideNoScript (pushed automatically)
[NAME] Rococo.uninit - array of uninit methods [TYPE] array [DESCRIPTION] Rococo.uninit is an array of functions which have no argument and are called at the time when window.onunload is called. [NOTE] Rococo library overwrites window.onunload. You should push functions to Rococo.init and should not overwrite window.onunload.
[NAME] Rococo.local.initOpera - Opera specific initialization [TYPE] function [DESCRIPTION] Rococo.local.initOpera is actually executed on Opera, and deletes document.firstChild.firstChild if it is a "comment" element. Google Maps append the "scrpit" element to document.firstChild.firstChild and only Opera returns the "comment" element, so Opera trys to append the "script" element to the "comment" element, and the error(HIERARCY_REQUEST_ERR) is occurred. [NOTE] This function is pushed into Rococo.init.
[NAME]
Rococo.initIeVml - initialization for IE VML
[TYPE]
function
[DESCRIPTION]
This method add one rule "v:\:* {behavior: url(#default#VML);}"
[NOTE]
Scripts using VML must call this method.
[NAME] Rococo.ut.CssNumberUnit - class storing CSS value (number + unit) [TYPE] constractor [SYMPOSIS] new Rococo.ut.CssNumberUnit(str); [ARGUMENTS] str : number + unit string (e.g. '10px', '100%' ...) [NOTICE] number=0 and unit='px' as default (if argument is null or invalid format)
[NAME] Rococo.ut.rtrim - delete spaces at tail [TYPE] function [SYMPOSIS] Rococo.ut.rtrim( str ); [ARGUMENTS] str : string [RETURNED VALUES] trimed string
[NAME] Rococo.ut.ltrim - delete spaces at head [TYPE] function [SYMPOSIS] Rococo.ut.ltrim( str ); [ARGUMENTS] str : string [RETURNED VALUES] trimed string
[NAME] Rococo.ut.trim - delete spaces at head and tail [TYPE] function [SYMPOSIS] Rococo.ut.trim( str ); [ARGUMENTS] str : string [RETURNED VALUES] trimed string
[NAME] Rococo.ut.isNumeric - numeric string test [TYPE] function [SYMPOSIS] Rococo.ut.isNumeric( str ); [ARGUMENTS] str : tested string [RETURNED VALUES] true - if str tests numeric. false - the other.
[NAME] Rococo.ut.isDigit - digit string test [TYPE] function [SYMPOSIS] Rococo.ut.siDigit( str ); [ARGUMENTS] str : tested string [RETURNED VALUES] true - if str tests digit. false - the other.
[NAME] Rococo.ut.isArray - array checker [TYPE] function [SYMPOSIS] Rococo.ut.isArray( obj ); [ARGUMENTS] obj : object [RETURNED VALUES] true - if obj is array. false - the other.
[NAME] Rococo.ut.isObject - object checker [TYPE] function [SYMPOSIS] Rococo.ut.isObject( obj ); [ARGUMENTS] obj : object [RETURNED VALUES] true - if obj is object. false - the other.
[NAME] Rococo.ut.getParamArray - get URL parameters [TYPE] function [ARGUMENTS] url : URL [RETURNED VALUES] object - the hash of parameters. null - if the url has no parameter.
[NAME] Rococo.ut.getUrlBody - get URL body ( excepting parameters ) [TYPE] function [ARGUMENTS] url : URL [RETURNED VALUES] string - URL body
[NAME] Rococo.ut.itoa - convert integer to string, with zero padding if needed. [TYPE] function [ARGUMENTS] num : integer fig : figure of string. [RETURNED VALUES] converted value (string) [NOTES] The minus sign is not counted as figure. (itoa(-1,2) returns "-01")
[NAME] Rococo.ut.encode_uri - uri encoder for compatibility issue. [TYPE] function [ARGUMENTS] txt : plain uri [RETURNED VALUES] encoded uri(IE) or plain uri(others) [NOTES] The encoded URI is needed by IE's XmlHttp, but the plain URI is needed by Safari's XmlHttp.
[NAME] Rococo.ut.getLastMday - last mday of this month [TYPE] function [ARGUMENTS] year : full year month : 1-12 [RETURNED VALUES] last mday ( 28, 29, 30 or 31 )
[NAME] Rococo.ut.isCorrectDate - test whether the hash is correct as date [TYPE] function [ARGUMENTS] date : hash with following properties year : Gregorian Year month : Month Number (1-12) mday : Day of Month (1-31) [RETURENED VALUES] true - if it is correct. false - not correct.
[NAME] Rococo.ut.inherit - inherit object [TYPE] function [ARGUMENTS] parent - object of parent class child - object of child class [NOTE] Bug (cannot override prototype members) fixed - 8th Sep, 2008
[NAME] Rococo.ut.extentInt - limit the value into the extent [TYPE] function [ARGUMENTS] value - integer value minvalue - minimum of value maxvalue - maximum of value nullvalue - returned value if value is null [RETURNED VALUE] limited integer value
[NAME] Rococo.ut.writeText - write text to ROCOCO element [TYPE] function [SYMPOSIS] Rococo.ut.writeText(element,text) [ARGUMENTS] element : DOM element object text : plain text string [RETURNED VALUES] element (one of arguments)
[NAME] Rococo.ut.writeXhtml - write XHTML to ROCOCO elements [TYPE] function [SYMPOSIS] Rococo.ut.writeXhtml(element,xhtmltext) [ARGUMENTS] element : DOM element object xhtmltext : string (or string array) with XHTML [RETURNED VALUES] element (one of arguments) [SEE ALSO] Rococo.ut.xmlToXHtml
[NAME] Rococo.ut.xmlToXHtml - convert XML-DOM elements to ROCOCO elements [TYPE] function [SYMPOSIS] Rococo.ut.xmlToXhtml(xmlelement); [ARGUMENTS] element : DOM element object [RETURNED VALUES] ROCOCO element which is converted [NOTICE] This method should be called by Rococo.ut.writeXHtml [SEE ALSO] Rococo.ut.writeXhtml
[NAME] Rococo.ut.xmlToObject - convert XML dom tree to Javascript object tree [TYPE] function [SYMPOSIS] Rococo.ut.xmlToObject(element); [ARGUMENTS] element - DOM element / document [RETURNED VALUES] Javascript object - succeeded null - failed [DESCRIPTION] xmlToObject converts XML dom tree to Javascript object tree, along to following rules : attributes: convert to one of property, overwrited if multiple elements : convert to one of property , push to array if multiple text nodes: usually conver to simple string. If the element has text nodes and, attributes or elements; values of text nodes are collected and set at '#text'. others : none convert to
[NAME] Rococo.ut.getObjectByPathArray - search Javascript object tree [TYPE] function [SYMPOSIS] Rococo.ut.getObjectByPathArray(object,arr_path); [ARGUMENTS] object - searched object arr_path - names of properties to search [RETURNED VALUES] objects - succeeded null - failed
[NAME] Rococo.ut.hideNoScript - hide all 'noscript' element on the document [TYPE] function [SYMPOSIS] Rococo.ut.hideNoScript(); [RETURNED VALUES] always null [SEE ALSO] Rococo.init [NOTICE] This method is pushed into Rococo.init hash.
[NAME] Rococo.ut.getElementsByClassName - get array of elements which has specified className [TYPE] function [SYMPOSIS] Rococo.ut.getElementsByClassName(element,className); [ARGUMENTS] element - DOM element; if null, search document className - className string checkMyself - if true, test if element contains className, not only children [RETURNED VALUES] null - not found array of DOM element - found
[NAME] Rococo.cl.UrlSetting - settings to cast HTTP query [TYPE] constractor [SYMPOSIS] object = new Rococo.cl.UrlSetting( url_body, rparams, method, caller ); [ARGUMENTS] url_body : the body of URL rparams : reserved paramaters to query method : HTTP method caller : the parameter name of callback function name (used only for JSONP) [SEE ALSO] Rococo.cl.UrlSetting.createFullUrl
[NAME] Rococo.cl.UrlSetting.createFullUrl - create url string [TYPE] function [SYMPOSIS] object.createFullUrl( [,arg1 [,arg2 [, ... ]]] ) [ARGUMENTS] object : UrlSetting Object argn : argument for URL which is complex of namr and value [RETURNED VALUES] URL string ( object.url_body?arg1&arg2&...&argn ) [SEE ALSO] Rococo.cl.UrlSetting
[NAME] Rococo.cl.DecisionSetting - settings to decision eather response indicates success or failure [TYPE] constractor [SYMPOSIS] object = new Rococo.cl.DecisionSetting( decisionpath, decisionvalue, errorpath ); [ARGUMENTS] decisionpath : path of XML tree or object to decision value decisionvalue : value (scalar or array) evaluated eather it euqals the value pointed by decisionpath errorpath : path of XML tree or object to error message [SEE ALSO] Rococo.cl.DecisionSetting.checkStatus Rococo.cl.DecisionSetting.getMessage [MEMO] decisionvalue can be array or scalar (25th April, 2009)
[NAME] Rococo.cl.DecisionSetting.checkStatus - check the status of the response along the setting [TYPE] function [SYMPOSIS] object.checkStatus( response_object ) [ARGUMENTS] object : Rococo.cl.DecisionSetting object response_object : response object (if response is XML, object must be converted to JavaScript object) [RETURNED VALUES] true : success false : failure [SEE ALSO] Rococo.cl.DecisionSetting
[NAME] Rococo.cl.DecisionSetting.getMessage - get error message along the setting [TYPE] function [SYMPOSIS] object.getMessage( response_object ) [ARGUMENTS] object : Rococo.cl.DecisionSetting object response_object : response object (if response is XML, object must be converted to JavaScript object) [RETURNED VALUES] string : succeeded to get the error message null : failed to get [SEE ALSO] Rococo.cl.DecisionSetting
[NAME] Rococo.cl.local.jsonp.reciever - JSONP reciever [TYPE] object [MEMBERS] PROPERTIES watching - the flag eather watch method is working or not timeoutms - indicates the interval to time out from start to call services watchinterval - indicates the interval between to call watch method and to call the next watch method holder - array of alive ( connecting ) RecCell CONSTRACTORS RecCell - the object stored JSONP calling status and callback settings METHODS request - method watch - watching RecCell array and processing time out or finishing procedures [SEE ALSO] Rococo.cl.local.jsonp.reciever.RecCell Rococo.cl.local.jsonp.reciever.watch Rococo.cl.local.jsonp.reciever.request
[NAME] Rococo.cl.local.jsonp.reciever.RecCell - JSONP reciever cell [TYPE] constractor [SYMPOSYS] new Rococo.cl.local.jsonp.reciever.RecCell( callback_function [MEMBERS] status : reciever status as bellow 0 : initial 1 : connecting 11 : recieved/timed out 12 : executing firecallback 21 : canceled 22 : executing firecancel 22 : waiting for time-out or recieving after canceled -1 : finished startms : the milliseconds when request is accepted callback_function : function called when the JSONP response arrives element : SCRIPT element (DOM element) parent : parent element of this.element (usually 'head' element ) handle : handle created when this object is created at Rococo.cl.local.jsonp.reciever.request(). [SEE ALSO] Rococo.cl.local.jsonp.reciever.RecCell.callback Rococo.cl.local.jsonp.reciever.request
[NAME]
Rococo.cl.local.jsonp.reciever.RecCell.callback - reciever from JSONP and set status = 3 (recieved).
[TYPE]
function
[SYMPOSIS]
object.callback(result [,succeeded]);
[ARGUMENTS]
object : RecCell object
result : result object from JSONP services
succeeded : true/false indicating whether ricieve JSONP data successfully (true as default)
[DESCRIPTION]
This is usually called from JSONP response as "Rococo.cl.local.jsonp.reciever.holder[n].callback({...});".
This set this.status as 11 (recieved).
[NOTICE]
This should be called from only JSONP
'succeeded' is set as false only if watcher detects timed out connection.
this.stauts 1 (connecting) to 11(recieved), or the other to -1(expired).
[SEE ALSO]
Rococo.cl.local.jsonp.reciever.RecCell
Rococo.cl.local.jsonp.reciever.watch
Rococo.cl.local.jsonp.reciever.RecCell.do_callback
[NAME] Rococo.cl.local.jsonp.reciever.RecCell.firecallback - really call callback function of the main script. [TYPE] function [SYMPOSIS] object.firecallback(); [DESCRIPTION] This callls this.callback_function whose arguments are this.succeeded and this.result set at callback() and set this.status as -1 (finished) [NOTICE] This should be called from only Rococo.cl.local.jsonp.reciever.RecCell.callback(), and must be called at least with this.result and this.succeeded property values are set. [SEE ALSO] Rococo.cl.local.jsonp.reciever.RecCell Rococo.cl.local.jsonp.reciever.RecCell.callback
[NAME] Rococo.cl.local.jsonp.reciever.RecCell.firecancel - really call cancel callback function of the main script. [TYPE] function [SYMPOSIS] object.firecancel(); [DESCRIPTION] This callls this.callback_function whose arguments are this.succeeded (must be false) and this.result set at callback() and set this.status as 22 (waiting after cancel) [NOTICE] This should be called from only Rococo.cl.local.jsonp.reciever.RecCell.callback(), and must be called at least with this.result and this.succeeded property values are set. [SEE ALSO] Rococo.cl.local.jsonp.reciever.RecCell Rococo.cl.local.jsonp.reciever.RecCell.callback
[NAME]
Rococo.cl.local.jsonp.reciever.request - request from local scripts to JSONP services
[TYPE]
function
[SYMPOSIS]
Rococo.cl.local.jsonp.reciever.request(urlset,params,callback);
[ARGUMENTS]
urlset : Rococo.cl.UrlSetting Object for JSONP request
params : parameters string ("arg1=value1&...") for JSONP request
callback : callback function
[RETURNED VALUE]
<=0 : id on jsonp reciever (used to cancel)
less than zero : failed
[NOTICE]
This should be called from only JSONP
If errors are occurred, request() calls callback function,
returned value is used only to cancel but not used to diagnosis.
[SEE ALSO]
Rococo.cl.local.jsonp.reciever.RecCell
Rococo.cl.UrlSetting
[NAME] Rococo.cl.local.jsonp.reciever.cancel - cancel JSONP connection [TYPE] function [ARGUMENTS] id : returned by Rococo.cl.local.jsonp.reciever.request [SEE ALSO] Rococo.cl.local.jsonp.reciever.request
[NAME] Rococo.cl.local.jsonp.reciever.watch - watching RecCell array and process [TYPE] function [ARGUMENTS] none [DESCRIPTION] This watches Rococo.cl.local.jsonp.reciever.holder, time out the element if needed and remove object and SCRIPT element if needed. Finishing this, call setTimeout to call watch after the interval set as Rococo.cl.local.jsonp.reciever.watchinterval. [NOTICE] This should be called from only JSONP [SEE ALSO] Rococo.cl.local.jsonp.reciever Rococo.cl.local.jsonp.reciever.RecCell
[NAME] Rococo.cl.jsonp.JsonpRequest - JSONP requester [TYPE] constractor [SYMPOSIS] object = new Rococo.cl.jsonp.JsonpRequest( title, urlset [,decisionset]); [ARGUMENTS] title - nickname of service to call urlset - URL settings (Rococo.cl.UrlSetting) decisionset - settings to decision eather response indicates success or failure (if decisionset is null, always success) [SEE ALSO] Rococo.cl.jsonp.JsonpRequest.request Rococo.cl.jsonp.JsonpRequest.onScriptLoad
[NAME] Rococo.cl.jsonp.JsonpRequest.request - send request [TYPE] function [SYMPOSIS] object.request( vparams, callback ); [ARGUMENTS] vparams : variable parameters which added to rparams at the object callback : callback function [SEE ALSO] Rococo.cl.jsonp.JsonpRequest
[NAME] Rococo.cl.jsonp.JsonpRequest.cancel - cancel request [TYPE] function [SYMPOSIS] object.cancel( id ); [ARGUMENTS] id : returned by Rococo.cl.jsonp.JsonpRequest.request [SEE ALSO] Rococo.cl.jsonp.JsonpRequest.request Rococo.cl.local.jsonp.reciever.cancel
[NAME] Rococo.cl.jsonp.JsonpRequest.onScriptLoad - precallback [TYPE] function [SYMPOSIS] object.onScriptLoad( status, callback, result ); [ARGUMENTS] status : indicates JSONP service response successfully callback : callback function result : result object [RETURENED VALUE] true/false : indicates eather succeeded [NOTICE] This should be called from the callback of Rococo.cl.local.jsonp.reciever.request . [SEE ALSO] Rococo.cl.jsonp.JsonpRequest
[NAME] Rococo.cl.xml.XmlRequest - XML HTTP requester [TYPE] constractor [SYMPOSIS] object = new Rococo.cl.xml.XmlRequest( title, urlset, decisionset ) [ARGUMENTS] title - nickname of service to call urlset - URL settings (Rococo.cl.UrlSetting) decisionset - settings to decision eather response indicates success or failure (if decisionset is null, always success) [SEE ALSO] Rococo.cl.xml.XmlRequest.request Rococo.cl.xml.XmlRequest.onReadyStateChange
[NAME] Rococo.cl.xml.XmlRequest.request - send request [TYPE] function [SYMPOSIS] object.request( vparams, callback [, data] ); [ARGUMENTS] vparams : variable parameters which added to rparams at the object callback : callback function data : sent data [RETURNED VALUES] always null [SEE ALSO] Rococo.cl.xml.XmlRequest
[NAME] Rococo.cl.xml.XmlRequest.onReadyStateChange - precallback [TYPE] function [SYMPOSIS] object.onReadyStateChange( req, callback ); [ARGUMENTS] req : XMLHttpRequest object callback : callback function [RETURNED VALUES] true/false : indicates if succeeded [SEE ALSO] Rococo.cl.xml.XmlRequest
[NAME]
Rococo.em.createElement - create ROCOCO element
[TYPE]
function
[SYMPOSIS]
Rococo.em.createElement( tagName [,cn_prefix [,id [,attributes]]] );
[ARGUMENTS]
tagName : tag name for DOM element
cn_prefix : prefix of className ('rococo' as default)
id : id of DOM element
attributes : attributes for child ROCOCO element
[RETURNED VALUES]
ROCOCO element (DOM appended methods and properties for ROCOCO element)
[NOTICE]
tagName is 'form', action is set as 'javascript:void(0)'
createElement set element its id, but recreateElement does not.
[SEE ALSO]
Rococo.em.recreateElement
[NAME]
Rococo.em.recreateElement - create ROCOCO element from DOM object
[TYPE]
function
[SYMPOSIS]
Rococo.em.recreateElement( element [,cn_prefix [,attributes]] );
[ARGUMENTS]
element : DOM element object
cn_prefix : prefix of className ('rococo' as default) which affect the element recreated by appendChild
attributes : attributes for child ROCOCO element
[RETURNED VALUES]
ROCOCO element (DOM appended methods and properties for ROCOCO element)
[DESCRIPTION]
recreateElement() injects the hash named 'rococo' into the DOM element
The has has following objects:
events - array whose element is constructed from type and handlers array (see addEventHandler)
roothandlers - DOM event listener settings, including 'eventtype' and 'handler' (see addEventHandler)
cn_prefix - prefix of CSS class name ('className' property)
children - children of ROCOCO element, not all of DOM elements should be stored.
And ROCOCO element has following methods:
createChld( element, subid, tagname, subcn, attributes )
recreateChild( element, subid, child, subcn, attributes )
setChild(subid,child)
getChild(subid)
clearAllChildren()
initValue(value)
getValue()
setValue(value)
getText()
addEventHandler(type,handler)
writeText(text)
writeXhtml(xhtmltext)
switchVisible(visible)
createCssClassName(subcn)
setSelectedIndex(value,error_index) - only 'select'
setCssMargin4(top,right,bottom,left)
setCssBorder4(style,color,top,right,bottom,left)
setCssPadding4(top,right,bottom,left)
setOpacity(opacity)
[NOTICE]
If tagName is 'form' and action is not set, action is set as 'javascript:void(0)'.
This method calls initValue() (not setValue()) for 'value' attributes.
[SEE ALSO]
Rococo.em.local.createChild
Rococo.em.local.recreateChild
Rococo.em.local.setChild
Rococo.em.local.getChild
Rococo.em.local.clearAllChildren
Rococo.em.local.initValue
Rococo.em.local.getValue
Rococo.em.local.setValue
Rococo.em.local.getText
Rococo.em.local.addEventHandler
Rococo.ut.writeText
Rococo.ut.writeXhtml
Rococo.em.local.switchVisible
Rococo.em.local.setSelectedIndex
Rococo.em.local.setCssMargin4
Rococo.em.local.setCssBorder4
Rococo.em.local.setCssPadding4
Rococo.em.local.getCssProperty
Rococo.em.local.setOpacity
[NAME] Rococo.em.local.createChild - create child ROCOCO element, but appended [TYPE] function [SYMPOSIS] Rococo.em.local.createChild( element, subid, tagName [,subcn [,attributes]] ); or element.createChild( subid, tagName [,subcn [,attributes]] ); [ARGUMENTS] element : ROCOCO element subid : identifier in the parent object(='element' argument) tagName : DOM tagname for new element subcn : sub classname (the classname set as cn_prefix+'-'+subcn). if null, subcn is set subid; if also subid is null, classname is set null. attributes : attributes for child ROCOCO element [RETURNED VALUES] child ROCOCO element object [NOTICE] createChild and recreateChild overwrite className property to child element. Other methods do not, because they do not create child element itself.
[NAME] Rococo.em.local.recreateChild - create child ROCOCO element from DOM element, but appended [TYPE] function [SYMPOSIS] Rococo.em.local.recreateChild( element, subid, child [,subcn [,attributes]] ); or element.recreateChild( subid, child [,subcn [,attributes]] ); [ARGUMENTS] element : ROCOCO element subid : identifier in the parent object(='element' argument) child : DOM element subcn : sub classname (the classname set as cn_prefix+'-'+subcn). if null, subcn is set subid; if also subid is null, classname is set null. attributes : attributes for child ROCOCO element [RETURNED VALUES] child ROCOCO element object [NOTICE] createChild and recreateChild overwrite className property to child element, and only recreateChld overwrite id if id of child element is null. Other methods do not, because they do not create child element itself.
[NAME] Rococo.em.local.setChild- set child ROCOCO element as ROCOCO element and as DOM element [TYPE] function [SYMPOSIS] Rococo.em.local.setChild( element, subid, child ); or element.setChild( subid, child ); [ARGUMENTS] element : ROCOCO element subid : identifier in the parent object (equals argument 'element') child : child ROCOCO element [RETURNED VALUES] child element
[NAME] Rococo.em.local.unseChild- remove child ROCOCO element as ROCOCO element and as DOM element [TYPE] function [SYMPOSIS] Rococo.em.local.unsetChild( element, subid ); or element.createElement( subid ); [ARGUMENTS] element : ROCOCO element subid : identifier in the parent object (equals argument 'element') [RETURNED VALUES] deleted element
[NAME] Rococo.em.local.clearAllChildren- clear all children as ROCOCO element and DOM element [TYPE] function [SYMPOSIS] Rococo.em.local.clearAllChildren( element ); or element.clearAllChildren(); [ARGUMENTS] element : ROCOCO element [RETURNED VALUES] none
[NAME] Rococo.em.local.getChild - get child ROCOCO element [TYPE] function [SYMPOSIS] Rococo.em.local.getChild( element, subid ); or element.getChild( subid ); [ARGUMENTS] element : ROCOCO element subid : identifier in the parent object (equals argument 'element') [RETURNED VALUES] child ROCOCO element if found with the key indicated by subid null if not found
[NAME] Rococo.em.local.initValue - set initial value of element [TYPE] function [SYMPOSIS] Rococo.em.local.initValue( element, value ); or element.initValue( value ); [ARGUMENTS] element : DOM element object value : value [NOTICE] This method usually calls setValue(), execpting checkbox (sets defaultChecked/defaultValue and calls setValue()). If value is null, value is changed to '' (blank string) instead of null. This method is called by the constractor. [RETURNED VALUES] value
[NAME] Rococo.em.local.getValue - get value of ROCOCO [TYPE] function [SYMPOSIS] Rococo.em.local.getValue( element ); or element.getValue(); [ARGUMENTS] element : DOM element object [RETURNED VALUES] value of ROCOCO element
[NAME] Rococo.em.local.extractText - extract text from the node and its children [TYPE] function [SYMPOSIS] Rococo.em.local.extractText(element) [ARGUMENTS] element : ROCOCO element object [RETURNED VALUES] extracted text (always not null)
[NAME] Rococo.em.local.setSelectedIndex - set selected index corresponding to the value [TYPE] function [SYMPOSIS] Rococo.em.local.setSelectedIndex( element, value ); or element.setSelectedIndex(value); [ARGUMENTS] element : ROCOCO element object value : value [RETURNED VALUES] selected index
[NAME] Rococo.em.local.setValue - set value of element [TYPE] function [SYMPOSIS] Rococo.em.local.setValue( element, value ); or element.setValue( value ); [ARGUMENTS] element : DOM element object value : value [NOTICE] if value is null, value is changed to '' (blank string) instead of null. [RETURNED VALUES] value
[NAME] Rococo.em.local.getText - get text of ROCOCO element [TYPE] function [SYMPOSIS] Rococo.em.local.getText( element ); or element.getText(); [ARGUMENTS] element : DOM element object [RETURNED VALUES] text of ROCOCO element (always not null)
[NAME]
Rococo.em.local.addEventHandler - set event handler
[TYPE]
function
[SYMPOSIS]
Rococo.em.local.addEventHandler(element,type,handler);
or
element.addEventHandler(type,handler);
[ARGUMENTS]
element : DOM element object
type : string of event type ('click', 'change' and so on)
handler : handler function. The function shall have one arguments which is event object.
[DESCRIPTION]
Along the Rococo Event Model (REM), ROCOCO elements can has more than zero handlers (functions) for each event type.
DOM Event Model can support multiple handler, but angents which do not support DOM Event Model cannot.
ROCOCO elements sotre the event handlers and the functions which call all of event handlers (with element.rococo.events, element.rococo.roothandlers).
Concretely, FireFox use addEventListener (DOM Event Model); but IE or Opera does not use addEventListener, but use element.rococo.events and element.rococo.roothandlers.
[RETURNED VALUES]
always null
[NAME] Rococo.em.local.setCssMargin4 - set css style (margin) [TYPE] function [SYMPOSIS] Rococo.em.local.setCssMargin4(element,top,right,bottom,left); or element.setCssMargin4(top,right,bottom,left); [ARGUMENTS] element : ROCOCO element top : top size text ( number + unit ) right : right size text ( number + unit ) bottom : bottom size text ( number + unit ) left : left size text ( number + unit ) [RETURNED VALUES] return null
[NAME] Rococo.em.local.setCssBorder4 - set css style (border) [TYPE] function [SYMPOSIS] Rococo.em.local.setCssBorder4(element,style,color,top,right,bottom,left); or element.setCssBorder4(style,color,top,right,bottom,left); [ARGUMENTS] element : ROCOCO element style : border style text color : border color text top : top size text ( number + unit ) right : right size text ( number + unit ) bottom : bottom size text ( number + unit ) left : left size text ( number + unit ) [RETURNED VALUES] return null
[NAME] Rococo.em.local.setCssPadding4 - set css style (padding) [TYPE] function [SYMPOSIS] Rococo.em.local.setCssPadding4(element,top,right,bottom,left); or element.setCssPadding4(top,right,bottom,left); [ARGUMENTS] element : ROCOCO element top : top size text ( number + unit ) right : right size text ( number + unit ) bottom : bottom size text ( number + unit ) left : left size text ( number + unit ) [RETURNED VALUES] return null
[NAME] Rococo.em.local.getCssProperty - get each CSS property (computedStyle or currentStyle) [TYPE] function [SYMPOSIS] Rococo.em.local.getCssProperty(element,name); or element.getCssProperty(name); [ARGUMENTS] element : ROCOCO element name : CSS name [RETURNED VALUES] return CSS property value [NOTICE] If document.defaultView.getComputedStyle is null and element.currentStyle is null, this method returns null
[NAME] Rococo.em.local.setOpacity - set current opacity [TYPE] function [SYMPOSIS] Rococo.em.local.setOpacity(element); or element.setOpacity(); [ARGUMENTS] element : ROCOCO element opacity : opacity rate [0,1] when start fading
[NAME] Rococo.em.local.switchVisible - change the display property of an element [TYPE] function [SYMPOSIS] Rococo.em.local.switchVisible(element,visible); or element.switchVisible(visible); [ARGUMENTS] element : DOM element object visible : true / false or null to reverse ( true to false, false to true ) [NOTICE] If this is called with visible=true, the display of the element must be set only 'block', not 'inline' or 'table'. [RETURNED VALUES] changed visible value
[NAME] Rococo.em.addVisibleSwitch - set the anchor for the visisble switch of element [TYPE] function [SYMPOSIS] Rococo.em.local.addVisibleSwitch(element,anchor,[type]); [ARGUMENTS] element : DOM element object anchor : anchor type : event type of visible switch trigger [RETURNED VALUES] return null
[NAME] Rococo.tk.Color - color object [TYPE] constractor [SYMPOSISY] object = new Rococo.tk.Color(red,green,blue) [ARGUMENTS] red : red value (0-255) green : green value (0-255) blue : blue value (0-255) [SEE ALSO] Rococo.tk.Color.join Rococo.tk.Color.getCssText
[NAME]
Rococo.tk.Color.join - create joined string
[TYPE]
function
[SYMPOSISY]
object.join([delimiter]);
[ARGUMENTS]
demiliter : specify demiliter string (',' as default)
[RETURNED VALUE]
color string joind and ordered by red, green and blue
[SEE ALSO]
Rococo.tk.Color
[NAME] Rococo.tk.Color.getCssText - create string used at CSS [TYPE] function [SYMPOSISY] object.getCssText(); [RETURNED VALUE] color string used at CSS [SEE ALSO] Rococo.tk.Color
[NAME] Rococo.tk.Color.equals - evaluate two color objects are equal [TYPE] function [SYMPOSISY] object.equals(color); [ARGUMENTS] color : color objects / hash including reg, green and blue [RETURNED VALUE] true : equal false : not euqual [SEE ALSO] Rococo.tk.Color
[NAME]
Rococo.tk.em.createElement - create ROCOCO ToolKit element
[TYPE]
function
[SYMPOSIS]
Rococo.tk.em.createElement( tagName [,cn_prefix [,id [,attributes]]] );
[ARGUMENTS]
tagname : tagname of root element
id : id of created element
cn_prefix : prefix of className ('rococo' as default)
attributes : attributes for child ROCOCO element
and special attributes as bellow:
legend_setting : settings for color legend includes following properties :
legend : legend object
target : target style property
list : list of options (new element is select element)
sequence : sequence setting (new element is select element)
value : default value (new element is select element)
[RETURNED VALUES]
ROCOCO ToolKit element (DOM appended methods and properties for ROCOCO element and ROCOCO ToolKit element)
[SEE ALSO]
Rococo.tk.em.recreateElement
Rococo.em.recreateElement
Rococo.tk.em.local.appendOptions
Rococo.tk.em.local.appendOptionsSequencial
[NAME]
Rococo.tk.em.recreateElement - create ROCOCO ToolKit element from DOM / ROCOCO element
[TYPE]
function
[SYMPOSIS]
Rococo.em.recreateElement( element [,cn_prefix [,id [,attributes]]] );
[ARGUMENTS]
element : DOM / ROCOCO element
cn_prefix : prefix of className ('rococo' as default)
id : id of created element
attributes : attributes for child ROCOCO element
and special attributes as bellow:
legend_setting : settings for color legend includes following properties :
legend : legend object
target : target style property
list : list of options (new element is select element)
sequence : sequence setting (new element is select element)
value : default value (new element is select element)
[DESCRIPTION]
ROCOCO ToolKit element is based on ROCOCO element.
The element is injected rococo.tk hash as bellow:
rococo.tk.setValue - elder setValue (Rococo.em.setValue)
rococo.tk.createChild - elder createChild (Rococo.em.createChild)
rococo.tk.legend -legend settings which has 'legend' and 'target' property
The element is inserted overwritten method:
setValue
createChild
and injected following methods:
setColor
'select' element is injected following methods:
appendOptions
appendOptionsSequencial
getSelectedValues
ROCOCO ToolKit element is also injected setColor method
[RETURNED VALUES]
ROCOCO ToolKit element (DOM appended methods and properties for ROCOCO element and ROCOCO ToolKit element)
[SEE ALSO]
Rococo.em.recreateElement
Rococo.tk.em.local.setColor
Rococo.em.local.initValue();
[NAME] Rococo.tk.local.em.setColor - set color along the color with legend object [TYPE] function [SYMPOSIS] Rococo.tk.local.em.setColor(element,value); or element.setColor( value ); [ARGUMENTS] value : value [RETURNED VALUES] CSS text of color
[NAME] Rococo.tk.local.em.appendOptions - append options to select ROCOCO element [TYPE] function [SYMPOSIS] Rococo.tk.local.em.appendOptions( select, arr_textvalue ); [ARGUMENTS] select : ROCOCO element append options to arr_textvalue : option settings, each element of arr_textvalue including 'text' and 'value' [DESCRIPTION] If the element of arr_textvalue including only 'text' or 'value', the other property set as same. [RETURNED VALUES] array of option elements
[NAME] Rococo.tk.local.em.appendOptionsSequencial - append numeric sequencial options to select ROCOCO element [TYPE] function [SYMPOSIS] Rococo.tk.local.em.appendOptionsSequencial( select, setting ); [ARGUMENTS] select : ROCOCO element append options to setting : settings contains following properties firstrow - number of first row lastrow - number of last row skip - numeric skip for each row (1 or -1 as default) figure - figure of text (optional) [RETURNED VALUES] null : uncorrect setting array : array of option elements
[NAME] Rococo.tk.local.em.getSelectedValues - get all selected values from select ROCOCO element [TYPE] function [SYMPOSIS] Rococo.tk.local.em.getSelectedValues( select ); select.getSelectedValues(); [ARGUMENTS] select : ROCOCO element [RETURNED VALUES] array of selected values
[NAME] Rococo.tk.legend.LinearLegend - color legend with linear gradation [TYPE] constractor [SYMPOSIS] object = new Rococo.tk.legend.LinearLegend(minvalue,maxvalue,minColor,maxColor); [ARGUMENTS] minvalue : minimum value (numeric) maxvalue : maximum value (numeric) minColor : the color hash (including red, green, blue) corresponding to minvalue maxColor : the color hash corresponding to maxvalue [SEE ALSO] Rococo.tk.legend.LinearLegend.getColor
[NAME] Rococo.tk.legend.LinearLegend.getColor - get the color corresponding to the specified value [TYPE] function [SYMPOSIS] object.getColor(value) [ARGUMENTS] value : value (numeric) [RETURNED VALUE] Rococo.tk.Color object : value is between minvalue and maxvalue null : value is not between minvalue and maxvalue
[NAME] Rococo.tk.legend.ExtentLegend - color legend with extent areas [TYPE] constractor [SYMPOSIS] object = new Rococo.tk.legend.ExtentLegend(boundaries,colors); [ARGUMENTS] boundaries : boundary of each color colors : array of Rococo.tk.Color [DESCRIPTION] If the first boundary or the last boundary is null, unbound for lower side or unbound for upper side. [NOTICE] boundaries.length must be colors.length + 1 the element of colors must be Rococo.tk.Color, not hash. [SEE ALSO] Rococo.tk.legend.ExtentLegend.getColor Rococo.tk.legend.ExtentLegend.createLegendElementTree
[NAME] Rococo.tk.legend.ExtentLegend.getColor - get the color corresponding to the specified value [TYPE] function [SYMPOSIS] object.getColor(value) [ARGUMENTS] value : value (numeric) [RETURNED VALUE] Rococo.tk.Color object : value is between minvalue and maxvalue null : value is not between minvalue and maxvalue
[NAME] Rococo.tk.legend.ExtentLegend.createLegendElementTree - create elements for legend [TYPE] function [SYMPOSIS] object.createLegendElementTree = function(element [,cn_prefix]); [ARGUMENTS] element : ROCOOC element to hold elements for legend cn_prefix : prefix of CSS class name, CSS class name of elements are set as "(cn_prefix)-(each suffix)" [RETURNED VALUE] holder element [DESCRIPTION] element tree is created as bellow: (element) -+- +- div.legendcell -+- div.color | +- p.text +- div.legendcell ...
[NAME] Rococo.tk.legend.DummyLegend - color legend with dummy values [TYPE] constractor [SYMPOSIS] object = new Rococo.tk.legend.DummyLegend(settings); [ARGUMENTS] settings : array of hash including following properties: value : dummy value color : color corresponding to the value (Rococo.tk.Color) [SEE ALSO] Rococo.tk.legend.DummyLegend.getColor Rococo.tk.legend.DummyLegend.createLegendElementTree
[NAME] Rococo.tk.legend.DummyLegend.getColor - get the color corresponding to the specified value [TYPE] function [SYMPOSIS] object.getColor(value) [ARGUMENTS] value : value (numeric) [RETURNED VALUE] Rococo.tk.Color object : the color corresponding to the value null : value is not found at settings
[NAME] Rococo.tk.legend.DummyLegend.createLegendElementTree - create elements for legend [TYPE] function [SYMPOSIS] object.createLegendElementTree = function(element [,cn_prefix]); [ARGUMENTS] element : ROCOOC element to hold elements for legend cn_prefix : prefix of CSS class name, CSS class name of elements are set as "(cn_prefix)-(each suffix)" [RETURNED VALUE] holder element [DESCRIPTION] element tree is created as bellow: (element) -+- +- div.legendcell -+- div.color | +- p.text +- div.legendcell ...
[NAME] Rococo.tk.Date - ROCOCO ToolKit element for Date [TYPE] object [ELEMENT TREE] (element) -+- input.year / select.year +- select.month +- select.month
[NAME]
Rococo.tk.createDate - create Date (ROCOCO ToolKit element)
[TYPE]
function
[SYMPOSIS]
Rococo.tk.createDate( tagname [,cn_prefix [,id [,attributes]]] );
[ARGUMENTS]
tagname : tagname of root element
id : id of created element
cn_prefix : prefix of className ('rococo' as default)
attributes : attributes for child ROCOCO element
and special attributes as bellow:
format : date format
yearlist : year canditate list ( year elemnt is select if exists, input if not)
value : initial value including 'year', 'month' or 'day' property
[RETURNED VALUES]
ROCOCO ToolKit element (DOM appended methods and properties for ROCOCO ToolKit element)
[SEE ALSO]
Rococo.tk.recreateDate
[NAME]
Rococo.tk.recreateDate - create Date (ROCOCO ToolKit element) from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.tk.recreateDate( element [,cn_prefix [,id [,attributes]]] );
[ARGUMENTS]
element : DOM element
id : id of created element
cn_prefix : prefix of className ('rococo' as default)
attributes : attributes for child ROCOCO element
and special attributes as bellow:
format : date format (see DESCRIPTION section)
yearlist : year canditate list ( year elemnt is select if exists, input if not)
value : initial value including 'year', 'month' or 'day' property, now date as default
[RETURNED VALUES]
ROCOCO ToolKit element (DOM appended methods and properties for ROCOCO ToolKit element)
[DESCRIPTION]
element is injected following methods:
getLastMday
resetMdayList
getValue
setValue
getText
and element.rococo is injected following property:
defaultYear, defaultMonth, defaultMday,
yearElement, monthElement, mdayElement,
dateFormat
format is a string contains following special characters:
Y : year (4 figures)
y : year (2 figures)
M, m : month
D, d : mday
special characters are replaced to the element and others are written as plain text.
for example 'm/d,Y', 'Y年M月D日'
[SEE ALSO]
Rococo.tk.recreateDate
[NAME]
Rococo.tk.local.Date.getLastMday - last mday at year and month specified by elements
[TYPE]
function
[SYMPOSIS]
Rococo.tk.local.Date.getLastMday(element);
or
element.getLastMday();
[ARGUMENTS]
element : Date ToolKit element
[RETURNED VALUES]
last mday (started from 1) of specified year
[DESCRIPTION]
getLastMday returns last mday of specified year.
If 'M' or 'm' is not set, always returns 31;
if 'y'(2 figures) and ('M' or 'm') is set, leap is set when year%4 == 0;
and if 'Y'(4 figures) and ('M' or 'm') is set, leap is set along Gregorian.
[NAME] Rococo.tk.local.Date.resetMdayList - reset mday list along year and month value [TYPE] function [SYMPOSIS] Rococo.tk.local.Date.resetMdayList(element); or element.resetMdayList(); [ARGUMENTS] element : Date tk element [RETURNED VALUES] always null
[NAME] Rococo.tk.local.Date.getValue - get the value of element [TYPE] function [SYMPOSIS] Rococo.tk.local.Date.getValue(element); or element.getValue(); [ARGUMENTS] element : Date ToolKit element [RETURNED VALUES] hash including year, month or mday
[NAME] Rococo.tk.local.Date.setValue - set the value to element [TYPE] function [SYMPOSIS] Rococo.tk.local.Date.setValue(element,value); or element.getValue(value); [ARGUMENTS] element : Date ToolKit element value : hash including year, month or mday [RETURNED VALUES] value (one of arguments)
[NAME] Rococo.tk.local.Date.getText - get the text of element along to the format [TYPE] function [SYMPOSIS] Rococo.tk.local.Date.getText(element); or element.getText(); [ARGUMENTS] element : Date ToolKit element [RETURNED VALUES] text along to the format. ex. element whose format is "M/D,Y" returns "May/23,2000"; element whose format is "Y年M月D日" returns "2004年1月3日"
[NAME] Rococo.pnl.Alert - ROCOCO Panel for Alert [TYPE] object [ELEMENT TREE] div --- div.alertholder -+- div.background | +- div.mainholder -+- (h2) | +- p | +- p ... +- form.actionholder
[NAME]
Rococo.pnl.createAlert - create Alert (ROCOCO Panel element)
[TYPE]
function
[SYMPOSIS]
Rococo.em.createAlert( [visible [,cn_prefix]] );
[ARGUMENTS]
visible : indicates whether element shows or does not at the first time
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.em.recreateAlert
[NAME]
Rococo.pnl.recreateAlert - create Alert (ROCOCO Panel element) from DOM object
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreateAlert( element, [visible [,cn_prefix]] );
[ARGUMENTS]
element : DOM element object
visible : indicates whether element shows or does not at the first time
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[DESCRIPTION]
recreateAlert() also calls Rococo.em.recreateElement()
and injects following methods into the element
show
hide
clear
[SEE ALSO]
Rococo.tk.em.recreateElement
Rococo.em.recreateElement
Rococo.pnl.local.Alert.show
Rococo.pnl.local.Alert.hide
Rococo.pnl.local.Alert.clear
[NAME]
Rococo.pnl.local.Alert.show - overwrite texts and buttons, and show the alert element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreateAlert( element, [title, [lines, [type, [listener]]]]);
or
element.recreateAlert( [title, [lines, [type, [listener]]]]);
[ARGUMENTS]
element : Alert element
title : title text of alert element
lines : text viewed in Alert. text is a part of HTML ( but it is not html element because each line is appended 'p' element )
type : type of form :
'simple' - only one button to close and continue
'confirm' - 'accept' to close and continue, and 'decline' to close
('simple' as default)
listeners : array of listeners whose element is the hash including 'type' and 'handler'.
'type' value is now available bellow:
'accept' : 'ACCEPT' button is clicked.
'decline' : 'DECLINE' button is clicked.
'close' : alert is closed;
if 'confirm' mode handled after 'accept' or 'decline' events handled,
if not 'confirm' mode, handled only this.
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[DESCRIPTION]
recreateAlert() also calls Rococo.em.recreateElement()
and injects following methods into the element
show
hide
clear
[SEE ALSO]
Rococo.pnl.recreateAlert
Rococo.pnl.local.Alert.clear
[NAME] Rococo.pnl.local.Alert.clear - clear all texts and buttons [TYPE] function [SYMPOSIS] Rococo.pnl.clear( element ); or element.clear(); [RETURNED VALUES] ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element) [SEE ALSO] Rococo.pnl.recreateAlert Rococo.pnl.local.Alert.clear
[NAME] Rococo.pnl.local.Alert.hide - hide the alert element , does not delete any child [TYPE] function [SYMPOSIS] Rococo.pnl.hide( element ); or element.hide(); [RETURNED VALUES] ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element) [SEE ALSO] Rococo.pnl.recreateAlert
[NAME] Rococo.pnl.local.Alert.createCB - create Close Button [TYPE] function [SYMPOSIS] Rococo.pnl.local.Alert.createCB(element,subid,text,[aahandlers]); [ARGUMENTS] element : ROCOCO form element subid : subid for element text : the text of button aahandlers : array of array of callback called when button is clicked [RETURNED VALUES] ROCOCO input element [NOTICE] This function maybe called by only recreateAlert. [SEE ALSO] Rococo.pnl.recreateAlert
[NAME] Rococo.pnl.Panel - ROCOCO Panel for Panel [TYPE] object [ELEMENT TREE] div -+- ( h2.title ) -+- a.switchmain | +- a.switchhelp +- div.rootholder -+- div.mainholder (*1) -+-. # | +- . # ... +- ( div.messageholder (*2) - div.message (*1) ) +- ( div.helpholder (*2) - div.help (*1) -+- p ... ) ( +- p.closehelp ) *1 : switched by CSS@media *2 : switched by a.switchmain or a.switchhelp
[NAME]
Rococo.pnl.createPanel - create Panel (ROCOCO Panel element)
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.createPanel( [title [,need_message [,helplines [,cn_prefix [,opened [,childrensettings [,childsubcn]]]]]]]] );
[ARGUMENTS]
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
childrensetings : array of setting for child element
childsubcn : subcn for item(child element)
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[SEE ALSO]
Rococo.pnl.recreatePanel
[NAME]
Rococo.pnl.recreatePanel - create Panel (ROCOCO Panel element) from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreatePanel( element [,title [,need_message [,helplines [,cn_prefix [,opened [,childrensettings [,childsubcn]]]]]]]] );
[ARGUMENTS]
element : DOM element
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of mainholder
childrensetings : array of setting for child element, settings has following properties:
subid : subid for mainholder
tagname : tagname of child element
subcn : sub classname for mainholder
attributes : attributes for new element
childsubcn : subcn for item(child element)
[DESCRIPTION]
recreatePanel injects rococo.panel hash which has following properties:
childsubcn
and injects following method:
appendItem
clearAllItems
getItem
setItem
writeMessageText
writeMessageXhtml
changeMainVisible
changeHelpVisible (if helpholder is created)
changeSwitchMain (if a.switchmain is created)
changeSwitchHelp (if a.switchhelp is created)
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.createPanel
Rococo.pnl.local.Panel.appendItem
Rococo.pnl.local.Panel.clearAllItems
Rococo.pnl.local.Panel.getItem
Rococo.pnl.local.Panel.setItem
Rococo.pnl.local.Panel.writeMessageText
Rococo.pnl.local.Panel.writeMessageXhtml
Rococo.pnl.local.Panel.switchMainVisible
Rococo.pnl.local.Panel.switchHelpVisible
Rococo.pnl.local.Panel.changeSwitchMain
Rococo.pnl.local.Panel.changeSwitchHelp
[NAME] Rococo.pnl.local.Panel.appendItem - append new item to mainholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.appendItem( element, subid [,tagname [,subcn [,attributes [,itemsubcn]]]] ); or element.appendItem( subid [,tagname [,subcn [,attributes [,itemsubcn]]]] ); [ARGUMENTS] element : Panel object subid : subid for mainholder at Panel tagname : tagname for new element subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", element.rococo.element.childsubcn as default attributes : attributes for new element [RETURNED VALUES] new element; ROCOCO ToolKit element as default, but FORM Panel element if tagname is form [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel Rococo.pnl.recreateForm
[NAME] Rococo.pnl.local.Panel.clearAllItems - clear all elements at mainholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.clearAllItems( element ); or element.clearAllItems(); [RETURNED VALUES] mainholder element
[NAME] Rococo.pnl.local.Panel.getItem - get item to mainholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.getItem( element, subid ); or element.getItem( subid ); [ARGUMENTS] element : Panel object subid : subid for mainholder at Panel [RETURNED VALUES] child element [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.local.Panel.setItem - set item to mainholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.setItem( element, subid, child ); or element.setItem( subid, child ); [ARGUMENTS] element : Panel object subid : subid for mainholder at Panel child : child rococo element [RETURNED VALUES] child element [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.local.Panel.writeMessageText - write plain text into the messageholder if exists [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.writeMessageXhtml( element, text [,append ] ); or element.writeMessageXhtml( text [, append ]); [ARGUMENTS] element : Panel element text : plain text string append: append mode (not cleared) if true; false as default [RETURNED VALUES] null if messageholder does not exist element (one of arguments) [SEE ALSO] Rococo.em.recreateElement Rococo.ut.writeText
[NAME] Rococo.pnl.local.Panel.writeMessageXhtml - write XHTML text into the messageholder if exists [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.writeMessageXhtml( element, xhtmltext [, append ] ); or element.writeMessageXhtml( xhtmltext [, append ] ); [ARGUMENTS] element : Panel element xhtmltext : string with XHTML// append: append mode (not cleared) if true; false as default append: append mode (not cleared) if true; false as default [RETURNED VALUES] null if messageholder does not exist element (one of arguments) [SEE ALSO] Rococo.em.recreateElement Rococo.ut.writeXhtml
[NAME] Rococo.pnl.local.Panel.switchMainVisible - switch visiblity of mainholder and messageholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.switchMainVisible( element, visible ); or element.swtichMainVisible( visible ); [ARGUMENTS] element: panel element visible: indicates visibility which the element will be switched to [RETURNED VALUES] true / false : indicating new visibility null : cannot change visibility (neither mainholder nor messageholder is not created) [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.local.Panel.switchHelpVisible - switch visiblity of helpholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.switchHelpVisible( element, visible ); or element.swtichMainVisible( visible ); [ARGUMENTS] element: panel element visible: indicates visibility which the element will be switched to [RETURNED VALUES] true / false : indicating new visibility null : cannot change visibility (div.help is not created) [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.local.Panel.changeSwitchMain - change title and className of the anchor of visibility switch for mainholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.changeSwitchMain( anchor, mainholder, title ); or element.changeSwitchMain(); [ARGUMENTS] element : panel element anchor : 'a' element mainholder: mainholder element title : title of the PANEL (not one of anchor) to change title of anchor [DESCRIPTION] This switches display style of mainholder, and title and className of anchor. The title of anchor is changed to the text including the title of the PANEL and 'open' or 'close' action; "open (title)", "close (title)" and so on. [NOTICE] This should be called from event listener of anchor. [RETURNED VALUES] new className of anchor [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.local.Panel.changeSwitchHelp - change title and className of the anchor of visibility switch for helpholder [TYPE] function [SYMPOSIS] Rococo.pnl.local.Panel.changeSwitchHelp( anchor, helpholder ); or element.changeSwitchHelp(); [ARGUMENTS] anchor : 'a' element helpholder : mainholder element element : panel element [DESCRIPTION] This switches display style of helpholder, and title and className of anchor. [NOTICE] This should be called from event listener of anchor. [RETURNED VALUES] new className of anchor [SEE ALSO] Rococo.pnl.createPanel Rococo.pnl.recreatePanel
[NAME] Rococo.pnl.PanelHolder - Panel Holder [TYPE] object [DESCRIPTION] PanelHolder is special ROCOCO ToolKit element injected appendItem and getItem to manage children elements as Panel. Each child has the same className (className can be changed by an argument of appendItem) to help CSS authoring.
[NAME]
Rococo.pnl.createPanelHolder - create Panel Holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.createPanelHolder( [cn_prefix [,itemsettings [,itemsubcn]]] );
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panelsettings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreatePanelHolder
[NAME]
Rococo.pnl.recreatePanelHolder - create Panel Holder from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreatePanelHolder( element, [,cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
element : DOM element
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panelsettings, including following properties:
subid : id
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
childrensettings : array of setting for child element at panel, each of them has following properties:
subid : subid for mainholder
tagname : tagname of child element
subcn : sub classname for mainholder
attributes : attributes for new element
opened : visibility of mainholder
childsubcn : subcn for item(child element)
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"
[DESCRIPTION]
recreatePanel injects rococo.panelholder hash which has following properties:
itemsubcn
and injects following method:
appendItem
getItem
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.createPanelHolder
Rococo.pnl.local.PanelHolder.appendItem
Rococo.pnl.local.PanelHolder.getItem
[NAME] Rococo.pnl.local.PanelHolder.appendItem - append new Panel to holder [TYPE] function [SYMPOSIS] Rococo.pnl.local.PanelHolder.appendItem( element, subid [,title [,need_message [,helplines [,opened [,childrensettings [,childsubcn [,subcn]]]]]]] ); or element.appendItem( subid [,title [,need_message [,helplines [,opened [,childrensettings [,childsubcn [,subcn]]]]]]] ); [ARGUMENTS] element : Panel Holder object subid : subid for mainholder at Panel Holder title : title text written at h2.title element need_message : switch to create message element helplines : texts written at helpholder opened : visibility of mainholder childrensettings : array of setting for child element, settings has following properties: subid : subid for mainholder tagname : tagname of child element subcn : sub classname for mainholder attributes : attributes for new element childsubcn : subcn for item(child element) subcn : suffix of className, className is created as "(cn_prefix)-(subcn)"; if null, subcn set as element.rococo.panelholder.itemsubcn [RETURNED VALUES] new Panel element [SEE ALSO] Rococo.pnl.recreatePanel Rococo.pnl.createPanelHolder Rococo.pnl.recreatePanelHolder
[NAME] Rococo.pnl.local.PanelHolder.getItem - get Panel from holder [TYPE] function [SYMPOSIS] Rococo.pnl.local.PanelHolder.getItem( subid ); or element.getItem( subid ); [ARGUMENTS] element : Panel Holder object subid : subid for mainholder at Panel Holder [RETURNED VALUES] child element [SEE ALSO] Rococo.pnl.createPanelHolder Rococo.pnl.recreatePanelHolder
[NAME]
Rococo.pnl.createForm- create form
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.createForm([cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings : array of form item settings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"; 'item' as default
[RETURNED VALUES]
Rococo.pnl.Form object
[NAME]
Rococo.pnl.recreateForm- create form
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.recreateForm(element, [cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
element : DOM element
cn_prefix : prefix of className ('rococo' as default)
itemsettings : array of form item settings, which has following properties:
subid : identifier for form
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)"; 'item' as default
attributes : attributes for input element
events : event handler for input element
[RETURNED VALUES]
Rococo.pnl.Form object
[SEE ALSO]
Rococo.pnl.createForm
Rococo.tk.em.recreateElement
Rococo.pnl.local.Form.createItem
[NAME]
Rococo.pnl.local.Form.appendItem - create form item
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.local.Form.appendItem(element, subid [,tagname [,title [,subcn [,attributes [,events]]]]]);
or
element.appendItem(subid,tagname,title,subcn,attributes,events);
[ARGUMENTS]
element : Rococo.pnl.Form object
subid : identifier for new element of form
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)" (element.rococo.form.itemsubcn as default)
attributes : attributes for input element (NOTICE: this affects only input element)
events : event handler for input element (NOTICE: this affects only input element)
[RETURNED VALUES]
new element of form ('div' ROCOCO ToolKit element)
[SEE ALSO]
Rococo.pnl.createForm
[NAME]
Rococo.pnl.createResult- create result
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.createResult([cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings : array of result item settings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"; 'item' as default
[RETURNED VALUES]
Rococo.pnl.Result object
[NAME]
Rococo.pnl.recreateResult- create result
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.recreateResult(cn_prefix,itemsettings);
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings : array of result item settings, which has following properties:
subid : identifier for result
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)"
attributes : attributes for input element
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"; 'item' as default
[RETURNED VALUES]
Rococo.pnl.Result object
[DESCRIPT]
Result is div element and has span (title) and span (value).
[SEE ALSO]
Rococo.pnl.createResult
Rococo.tk.em.recreateElement
Rococo.pnl.local.Result.createItem
[NAME]
Rococo.pnl.local.Result.appendItem - create result item
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.local.Result.appendItem(element,subid,title,subcn,attributes);
or
element.createRestulItem(subid,title,subcn,attributes);
[ARGUMENTS]
element : Rococo.pnl.Result object
subid : identifier for new element of result
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)"
attributes : attributes for input element (NOTICE: this affects only input element)
[RETURNED VALUES]
new element of result ('div' ROCOCO ToolKit element)
[SEE ALSO]
Rococo.pnl.createResult
[NAME] Rococo.pnl.FreePanelHolder - FreePanel Holder [TYPE] object [DESCRIPTION] FreePanelHolder is the special PanelHolder. FreePanelHolder is only used to create the special PanelHolder whose children have the same className values which is "(cn_prefix)-freepanel". [SEE ALSO] Rococo.pnl.PanelHolder
[NAME]
Rococo.pnl.createFreePanelHolder - create FreePanel Holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.createFreePanelHolder( [cn_prefix [,itemsettings [,itemsubcn]]] );
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panelsettings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreateFreePanelHolder
[NAME]
Rococo.pnl.recreateFreePanelHolder - create FreePanel Holder from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreateFreePanelHolder( element [,cn_prefix [,itemsettings [,itemsubcn]]] );
[ARGUMENTS]
element : DOM element
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panel settings (see Rococo.pnl.recreatePanelHolder)
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)", 'freepanel' as default
[DESCRIPTION]
recreateFreePanelHolder calls recreatePanelHolder
and set rococo.panelholder.itemsubcn set itemsubcn or 'freepanel'
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreatePanelHolder
Rococo.pnl.createFreePanelHolder
[NAME] Rococo.pnl.Menu - ROCOCO Panel for MENU and MENU ITEM [TYPE] object [ELEMENT TREE] div -+- ( h2.title ) -+- a.switchmain | +- a.switchhelp +- div.rootholder -+- div.mainholder (*1) - form.input -+- div.item | | +- div.item ... | +-. # ... +- ( div.helpholder (*2) - div.help (*1) -+- p ... ) ( +- p.closehelp ) div.item -+- span.title +- .input *1 : switched by CSS@media *2 : switched by a.switchmain or a.switchhelp [DESCRIPTION] Rococo.pnl.Menu is based on Rococo.pnl.Panel, and injected original methods 'appendItem' and 'getItem' to skip getChild('rootholder').getChild('mainholder') [SEE ALSO] Rococo.pnl.Panel
[NAME]
Rococo.pnl.createMenu- create menu
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.createMenu([title [,helplines [,cn_prefix [,opened [,childrensettings]]]]]);
[ARGUMENTS]
title : title text written at h2.title element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
childrensettings : array of menu item settings
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[RETURNED VALUES]
Rococo.pnl.Menu object
[NAME]
Rococo.pnl.recreateMenu- create menu
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.createMenu([title [,helplines [,cn_prefix [,opened [,childrensettings]]]]]);
[ARGUMENTS]
title : title text written at h2.title element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
childrensettings : array of menu item settings, which has following properties:
subid : identifier for Menu
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", 'item' as default
attributes : attributes for input element
events : event handler for input element
[DESCRIPTION]
Rococo.pnl.Menu is based on Rococo.pnl.Panel,
and injected original methods 'appendItem' and 'getItem'.
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[RETURNED VALUES]
Rococo.pnl.Menu object
[SEE ALSO]
Rococo.pnl.createMenu
Rococo.tk.em.recreateElement
Rococo.pnl.local.Menu.appendItem
Rococo.pnl.local.Menu.getItem
[NAME] Rococo.pnl.local.Menu.appendItem - append MENU ITEM to MENU [TYPE] function [SYMPOSIS] Rococo.pnl.local.Menu.appendItem(element,subid,tagname,title,subcn,attributes,events); or element.appendItem(subid,tagname,title,subcn,attributes,events); [ARGUMENTS] element : Rococo.pnl.Menu object subid : identifier for Menu tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element title : title of input subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", 'item' as default attributes : attributes for input element (NOTICE: this affects only input element) events : event handler for input element (NOTICE: this affects only input element) [RETURNED VALUES] new MENU ITEM object (ROCOCO ToolKit element) [SEE ALSO] Rococo.pnl.createMenu Rococo.pnl.local.Menu.getItem
[NAME]
Rococo.pnl.local.Menu.getItem - get MENU ITEM from MENU
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.local.Menu.getItem(element,subid);
or
element.getItem(subid);
[ARGUMENTS]
element : Rococo.pnl.Menu object
subid : identifier for Menu
[DESCRIPTION]
getItem is used to skip getChild('rootholder').getChild('mainholder').
[RETURNED VALUES]
MENU ITEM object (ROCOCO ToolKit element)
[SEE ALSO]
Rococo.pnl.createMenu
Rococo.pnl.local.Menu.appendItem
[NAME] Rococo.pnl.MenuHolder - Menu Holder [TYPE] object [DESCRIPTION] MenuHolder is the special PanelHolder. MenuHolder is used to create Menu whose children have the same className values which is "(cn_prefix)-menu". [SEE ALSO] Rococo.pnl.PanelHolder
[NAME]
Rococo.pnl.createMenuHolder - create Menu Holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.createMenuHolder( [cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panelsettings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreateMenuHolder
[NAME]
Rococo.pnl.recreateMenuHolder - create Menu Holder from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreateMenuHolder( element [,cn_prefix [,itemsettings [,itemsubcn]]]);
[ARGUMENTS]
element : DOM element
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of Menu settings, including following properties:
subid : id
title : title text written at h2.title element
helplines : texts written at helpholder
childrensettings : array of setting for child element at Menu, each of them has following properties:
subid : subid for mainholder
tagname : tagname of child element
title : title of input
subcn : sub classname for mainholder
attributes : attributes for new element
events : event handler for input element
opened : visibility of mainholder
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(itemsubcn)", 'menu' as default
[DESCRIPTION]
recreateMenuHolder calls recreatePanelHolder and overwrite only appendItem method.
recreateMenuHolder injects following properties:
rococo.panelholder (by recreatePanelHolder), including following properties:
itemsubcn
and injects following method:
appendItem (overwritten by recreateMenuHolder)
getItem (by recreatePanelHolder)
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreatePanelHolder
Rococo.pnl.createMenuHolder
Rococo.pnl.local.MenuHolder.appendItem
[NAME]
Rococo.pnl.local.MenuHolder.appendItem - append new Menu to holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.local.MenuHolder.appendItem( element, subid [,title [,helplines [,cn_prefix [,opened [,childrensettings [,subcn]]]]]]);
or
element.appendItem( subid [,title [,helplines [,title [,helplines [,cn_prefix [,opened [,childrensettings [,subcn]]]]]]);
[ARGUMENTS]
element : Menu Holder object
subid : subid for mainholder at Menu Holder
title : title text written at h2.title element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
childrensettings : array of menu item settings, which has following properties:
subid : identifier for Menu
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", 'item' as default
attributes : attributes for input element
events : event handler for input element
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)";
if null, subcn set as element.rococo.panelholder.itemsubcn
[RETURNED VALUES]
new Menu element
[SEE ALSO]
Rococo.pnl.recreateMenu
Rococo.pnl.createMenuHolder
Rococo.pnl.recreateMenuHolder
[NAME] Rococo.pnl.Console - ROCOCO Panel for Console and Console item [TYPE] object [ELEMENT TREE] div -+- ( h2.title ) -+- a.switchmain | +- a.switchhelp +- div.rootholder -+- div.mainholder (*1) -+- form.input | +- div.result +- ( div.messageholder (*2) - div.message (*1) ) +- ( div.helpholder (*2) - div.help (*1) -+- p ... ) ( +- p.closehelp ) form.input -+- div.item -+- span.title | +-.input +- div.item ... div.result -+- div.item -+- span.title | +- span.value +- div.item ... *1 : switched by CSS@media *2 : switched by a.switchmain or a.switchhelp [DESCRIPTION] Rococo.pnl.Console is based on Rococo.pnl.Panel, and injected original methods 'appendItem' and 'getItem' to skip getChild('rootholder').getChild('mainholder') [SEE ALSO] Rococo.pnl.Panel
[NAME]
Rococo.pnl.createConsole- create Console
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.createConsole(need_input, need_result [,title [,need_message [,helplines [,cn_prefix [,opened [,inputchildrensettings [,resultchildrensettings]]]]]]]);
[ARGUMENTS]
need_input : switch to create form.input element
need_result : switch to create div.result element
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
inputchildrensettings : array of console item settings for form.input
resultchildrensettings : array of console item settings for div.result
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[RETURNED VALUES]
Rococo.pnl.Console object
[NAME]
Rococo.pnl.recreateConsole- create Console
[TYPE]
constractor
[SYMPOSIS]
object = Rococo.pnl.recreateConsole(element, need_input, need_result [,title [,need_message [,helplines [,cn_prefix [,opened [,inputchildrensettings [,resultchildrensettings]]]]]]]);
[ARGUMENTS]
element : DOM element
need_input : switch to create form.input element
need_result : switch to create div.result element
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
inputchildrensettings : array of console item settings, which has following properties:
subid : identifier for Console
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", 'item' as default
attributes : attributes for input element
events : event handler for input element
resultchildrensettings : array of console item settings, which has following properties:
subid : identifier for Console
tagname : ROCOCO ToolKit tagname (see Rococo.tk.em.recreateElement) for input element
title : title of input
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)", 'item' as default
attributes : attributes for input element
[DESCRIPTION]
Rococo.pnl.Console is based on Rococo.pnl.Panel,
automatically inserted Rococo.pnl.Form element and Rococo.pnl.ResultHolder element,
and injected original methods :
if need_input is true,
appendInputItem( subid, tagname, title, subcn, attributes, events )
getInputItem(subid)
if need_result is true,
appendResultItem( subid, title, subcn, attributes )
getResultItem(subid)
to skip (getChild('input') and getChild('result')).
[NOTICE]
HTML tag can be inserted into helplines, but this method automatically append at head and
at tail.
[RETURNED VALUES]
Rococo.pnl.Console object
[SEE ALSO]
Rococo.pnl.createConsole
Rococo.tk.em.recreateElement
Rococo.pnl.recreateForm
Rococo.pnl.local.Form.appendItem
Rococo.pnl.local.Form.getItem
Rococo.pnl.recreateResult
Rococo.pnl.local.Result.appendItem
Rococo.pnl.local.Result.getItem
[NAME] Rococo.pnl.ConsoleHolder - Console Holder [TYPE] object [DESCRIPTION] ConsoleHolder is the special PanelHolder. ConsoleHolder is only used to create the special PanelHolder whose children have the same className values which is "(cn_prefix)-console". [SEE ALSO] Rococo.pnl.PanelHolder
[NAME]
Rococo.pnl.createConsoleHolder - create Console Holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.createConsoleHolder( [cn_prefix [,itemsettings [,itemsubcn]]] );
[ARGUMENTS]
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panelsettings
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)"
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreateConsoleHolder
[NAME]
Rococo.pnl.recreateConsoleHolder - create Console Holder from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.recreateConsoleHolder( element [,cn_prefix [,itemsettings [,itemsubcn]]] );
[ARGUMENTS]
element : DOM element
cn_prefix : prefix of className ('rococo' as default)
itemsettings: array of panel settings (see Rococo.pnl.recreatePanelHolder)
itemsubcn: suffix of className of panel (not holder), className is created as "(cn_prefix)-(subcn)", 'console' as default
[DESCRIPTION]
recreateConsoleHolder calls recreatePanelHolder
and set rococo.panelholder.itemsubcn set itemsubcn or 'console'
[RETURNED VALUES]
ROCOCO Panel element (DOM appended methods and properties for ROCOCO Panel element)
[SEE ALSO]
Rococo.pnl.recreatePanelHolder
Rococo.pnl.createConsoleHolder
[NAME]
Rococo.pnl.local.ConsoleHolder.appendItem - append new Console to holder
[TYPE]
function
[SYMPOSIS]
Rococo.pnl.local.ConsoleHolder.appendItem( element, subid [,need_input [,need_result [,title [,need_message [,helplines [,cn_prefix [,opened [,inputchildrensettings [,resultchildrensettings [,subcn]]]]]]]]]]);
or
element.appendItem( subid [,need_input [,need_result [,title [,need_message [,helplines [,cn_prefix [,opened [,inputchildrensettings [,resultchildrensettings [,subcn]]]]]]]]]]);
[ARGUMENTS]
element : Console Holder object
subid : subid for mainholder at Console Holder
need_input : switch to create form.input element
need_result : switch to create div.result element
title : title text written at h2.title element
need_message : switch to create message element
helplines : texts written at helpholder
cn_prefix : prefix of className ('rococo' as default)
opened : visibility of rootholder
inputchildrensettings : array of console item settings for form.input
resultchildrensettings : array of console item settings for div.result
subcn : suffix of className, className is created as "(cn_prefix)-(subcn)";
if null, subcn set as element.rococo.panelholder.itemsubcn
[RETURNED VALUES]
new Menu element
[SEE ALSO]
Rococo.pnl.recreateMenu
Rococo.pnl.createMenuHolder
Rococo.pnl.recreateMenuHolder
[NAME] Rococo.eui.BarChart - ROCOCO EUI for Bar Chart [TYPE] object [ELEMENT TREE] table - tbody.tbody -+- tr.headrow -+- th.head | th.bar | th.padding | th.data | +- th ... | +- tr.datarow -+- th.head | td.bar | td.data +- td ... * : tr , th and td have not id, but have className.
[NAME]
Rococo.eui.createBarChart - create Bar Chart (ROCOCO EUI)
[TYPE]
function
[SYMPOSIS]
Rococo.em.createBarChart( settings [,cn_prefix] );
[ARGUMENTS]
settings : bar chart settings (see recreateBarChart)
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[SEE ALSO]
Rococo.em.createBarChart
[NAME]
Rococo.eui.recreateBarChart - create Bar Chart (ROCOCO EUI) from DOM object
[TYPE]
function
[SYMPOSIS]
Rococo.em.recreateBarChart( element, settings [,cn_prefix] );
[ARGUMENTS]
element : DOM element object
settings : bar chart settings (see recreateBarChart)
cn_prefix : prefix of className ('rococo' as default) which affect the element recreated by appendChild
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[DESCRIPTION]
recreateBarChart() creates Bar Chart EUI into the DOM element.
recreateBarChart() also calls Rococo.em.recreateElement()
to injects the has named 'rococo' and properites if element is not ROCOCO element.
settings are for columns and an element of settings may contains following properties:
bar setting (bar at lefthand and value text bar at righthand):
type - type of this column and must be 'bar'
barwidth - hash of bar width setting for bar
value : width number
unit : the unit of width : ex. 'px', 'em'
color : Rococo.em.Color object for default bar color
legend : legend objects (ex. Rococo.tk.LinearLegend) for variable bar color
maxvalue : maxvalue for this bar
minvalue : minvalue for this bar
valueunit : the unit of value which is constant value and printed after value text
textwidth : width setting for value text
title : title which is written at the first row
data setting (only simple text):
type - type of this column and must be 'data'
textwidth : width setting for text
title: title which is written at the first row
[SEE ALSO]
Rococo.em.recreateElement
Rococo.tk.LinearLegend
Rococo.tk.Color
[NAME]
Rococo.eui.local.BarChart.resetHeadRow - reset all rows and create the head row (=first row)
[TYPE]
function
[SYMPOSIS]
Rococo.eui.local.BarChart.resetHeadRow( element, settings );
or
element.resetHeadRow( settings );
[ARGUMENTS]
settings : column settings. see Rococo.eui.recreateBarChart
element : BarChart element
[RETURNED VALUES]
child ROCOCO element object ('tr' element)
[NAME] Rococo.eui.local.BarChart.clearDataRows - clear all data rows, but the head row is maintained. [TYPE] function [SYMPOSIS] Rococo.eui.local.BarChart.clearDataRows( element ); or element.clearDataRows(); [ARGUMENTS] element : BarChart element [RETURNED VALUES] always null
[NAME] Rococo.eui.local.BarChart.appendData - append data rows [TYPE] function [SYMPOSIS] Rococo.eui.local.BarChart.appendData( element, data ); or element.appendData( data ); [ARGUMENTS] element : BarChart element data : 2d array ( array of array along the column settings) [RETURNED VALUES] array of elements which are created by appendData [SEE ALSO] Rococo.eui.local.BarChart.appendDataRow
[NAME]
Rococo.eui.local.BarChart.appendDataRow - append one data row
[TYPE]
function
[SYMPOSIS]
Rococo.eui.local.BarChart.appendDataRow( element, datarow );
or
element.appendDataRow( datarow );
[ARGUMENTS]
element : BarChart element
datarow : 1d array along the column settings
[RETURNED VALUES]
appended element ('tr' element)
[NAME] Rococo.eui.VBarChart - ROCOCO EUI for Vertical Bar Chart [TYPE] object [ELEMENT TREE] table - tbody.tbody -+- tr.datarow -+- th.head | +- td.bar ... | +- tr.padding --- th.padding | +- tr.headrow -+- th.head +- th * : tr , th and td have not id, but have className.
[NAME]
Rococo.eui.createVBarChart - create Vertical Bar Chart (ROCOCO EUI)
[TYPE]
function
[SYMPOSIS]
Rococo.em.createVBarChart( settings [,cn_prefix] );
[ARGUMENTS]
settings : bar chart settings (see recreateVBarChart)
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[SEE ALSO]
Rococo.em.createVBarChart
[NAME]
Rococo.eui.recreateVBarChart - create Vertical Bar Chart (ROCOCO EUI) from DOM object
[TYPE]
function
[SYMPOSIS]
Rococo.em.recreateVBarChart( element, settings [,cn_prefix] );
[ARGUMENTS]
element : DOM element object
settings : bar chart settings
cn_prefix : prefix of className ('rococo' as default) which affect the element recreated by appendChild
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[DESCRIPTION]
recreateVBarChart() creates Vertical Bar Chart EUI into the DOM element.
recreateVBarChart() also calls Rococo.em.recreateElement()
to injects the has named 'rococo' and properites if element is not ROCOCO element.
settings are for columns and an element of settings may contains following properties:
bar setting (bar at lefthand and value text bar at righthand):
type - type of this column and must be 'vbar'
barheight - hash of bar width setting for bar
value : height number
unit : the unit of height : ex. 'px', 'em'
color : Rococo.em.Color object for default bar color
legend : legend objects (ex. Rococo.tk.LinearLegend) for variable bar color
maxvalue : maxvalue for this bar
minvalue : minvalue for this bar
valueunit : the unit of value which is constant value and printed after value text
title : title which is written at the first row
data setting (only simple text):
type - type of this column and must be 'data'
title: title which is written at the first row
textwidth - けし
barwidth -> barheight
[SEE ALSO]
Rococo.em.recreateElement
Rococo.tk.LinearLegend
Rococo.tk.Color
[NAME]
Rococo.eui.local.VBarChart.resetAll - reset all rows and create the head row (=first row)
[TYPE]
function
[SYMPOSIS]
Rococo.eui.local.VBarChart.resetAll( element, settings );
or
element.resetAll( settings );
[ARGUMENTS]
settings : column settings. see Rococo.eui.recreateVBarChart
element : VBarChart element
[RETURNED VALUES]
child ROCOCO element object ('tr' element)
[NAME] Rococo.eui.local.VBarChart.clearData - clear all data columns. [TYPE] function [SYMPOSIS] Rococo.eui.local.VBarChart.clearData( element ); or element.clearData(); [ARGUMENTS] element : VBarChart element [RETURNED VALUES] always null
[NAME] Rococo.eui.local.VBarChart.appendData - append data rows [TYPE] function [SYMPOSIS] Rococo.eui.local.VBarChart.appendData( element, data ); or element.appendData( data ); [ARGUMENTS] element : VBarChart element data : 2d array ( array of array along the column settings) [RETURNED VALUES] array of elements which are created by appendDataColumn [SEE ALSO] always null
[NAME] Rococo.eui.local.VBarChart.appendDataColumn - append one data row [TYPE] function [SYMPOSIS] Rococo.eui.local.VBarChart.appendDataColumn( element, datacol ); or element.appendDataColumn( datacol ); [ARGUMENTS] element : VBarChart element datacol : 1d array along the column settings [RETURNED VALUES] always null
[NAME] Rococo.eui.Matrix - ROCOCO EUI for Matrix [TYPE] object [ELEMENT TREE] table - tbody.tbody -+- tr.headrow -+- th.head | +- th ... | +- tr.bodyrow -+- th.head +- td.center (1) +- td ... *1: className cn_prefix+'-center' is set only at center cell * : all of "tr" and "th" are DOM elements, only "td" elements are ROCOCO element
[NAME] Rococo.eui.local.Matrix.createMatrixCell - create Matrix Cell [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.createMatrixCell( tagname [, legend_settings [,attributes]] ); [ARGUMENTS] tagname : tagname of created element legend_settings : color legend including following properties lagend : legend object target : target style property attributes : attributes for child ROCOCO ToolKit element [RETURNED VALUES] ROCOCO ToolKit element [SEE ALSO] Rococo.eui.local.Matrix.recreateMatrixCell
[NAME] Rococo.eui.local.Matrix.recreateMatrixCell - create Matrix Cell from DOM element [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.recreateMatrixCell( element [,legend_settings [,attributes]] ); [ARGUMENTS] element : DOM element legend_settings : color legend including following properties lagend : legend object target : target style property attributes : attributes for child ROCOCO ToolKit element [RETURNED VALUES] ROCOCO ToolKit element [DESCRIPTION] This overwrite setValue. [SEE ALSO] Rococo.eui.local.Matrix.createMatrixCell
[NAME] Rococo.eui.local.MatrixCell.setValue - set the value for Matrix Cell [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.setValue( element, value ); or element.setValue(value) [ARGUMENTS] element : Matrix Cell element value : array, hash or scalar [RETURNED VALUES] set value [DESCRIPTION] This set a value and multi row texts. values which affect to the legend is specified as bollow: scalar : value itself array : the first value hash : the value sotred as 'value' property [SEE ALSO] Rococo.eui.local.Matrix.recreateMatrixCell
[NAME]
Rococo.eui.createMatrix - create Matrix (ROCOCO EUI element)
[TYPE]
function
[SYMPOSIS]
Rococo.eui.createMatrix( settings [,cn_prefix] );
[ARGUMENTS]
settings : matrix settings
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[SEE ALSO]
Rococo.eui.recreateMatrix
[NAME]
Rococo.eui.recreateMatrixCell - create Matrix Cell from DOM element
[TYPE]
function
[SYMPOSIS]
Rococo.eui.createMatrix( element, settings [,cn_prefix] );
[ARGUMENTS]
element : DOM element
settings : matrix settings :
width : width of each cell with CSS style (ex. '3em' )
height : height of each cell wih CSS style
rowheads : array of head row texts
colheads : array of head column texts
legend : color legend object
cn_prefix : prefix of className ('rococo' as default)
[RETURNED VALUES]
ROCOCO EUI element (DOM appended methods and properties for ROCOCO EUI element)
[DESCRIPTION]
recreateMatrix() creates Matrix EUI into the DOM element.
It also calls Rococo.em.recreateElement()
to inject the hash named 'rococo' and properties if element is not ROCOCO element.
recreateMatrix inject following methods:
resetAll
clearData
setData
setDataRow
[SEE ALSO]
Rococo.eui.createMatrix
Rococo.eui.local.Matrix.recreateMatrixCell
[NAME] Rococo.eui.local.Matrix.resetAll - remove and create all cells [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.resetAll( element, settings ); or element.resetAll( element, settings ); [ARGUMENTS] element : matrix cell settings : matrix settings [RETURNED VALUES] always null [SEE ALSO] Rococo.eui.recreateMatrix
[NAME] Rococo.eui.local.Matrix.clearData - remove children of all cells [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.clearData( element ); or element.clearData(); [ARGUMENTS] element : matrix cell [RETURNED VALUES] always null
[NAME] Rococo.eui.local.Matrix.setData - set data for each cell [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.setData( element, data ); or element.setData( data ); [ARGUMENTS] element : matrix cell data : array of arrays of values [RETURNED VALUES] data (one of arguments)
[NAME] Rococo.eui.local.Matrix.setRowData - set data for each cell at specified row [TYPE] function [SYMPOSIS] Rococo.eui.local.Matrix.setRowData( element, row, data ); or element.setData( row, data ); [ARGUMENTS] element : matrix cell row : row number (0-,excepting head row) datarow : array of values [RETURNED VALUES] row by datarow and row (some of arguments)
[NAME] Rococo.geo.Mesh - geographical mesh [TYPE] constractor [SYMPOSIS] object = new Rococo.geo.Mesh(sec,skip,offset); [ARGUMENTS] level : Mesh System Level ( 1, 2 or 3 ) sec : potision hash including 'lat'(second) and 'lon'(second) skip : skip seconds for one mesh, including 'lat'(second) and 'lon'(second) offset : offset for original mesh, including 'lat'(second) and 'lon'(second) [DESCRIPTION] If skip.lat is less than 0, mesh will be expanded to south. If skip.lon is less than 0, mesh will be expanded to west.
[NAME] Rococo.geo.Mesh.add - add by mesh object [TYPE] function [SYMPOSIS] Rococo.geo.Mesh.add(op); [ARGUMENTS] op : operand, which is Rococo.geo.Mesh object [RETURNED VALUES] new Rococo.geo.Mesh object
[NAME] Rococo.geo.Mesh.addByMeshNumber - add by mesh number ( or count ) [TYPE] function [SYMPOSIS] Rococo.geo.Mesh.addByMeshNumber(meshunum); [ARGUMENTS] meshnum : operand, which is mesh number(or count) including 'lat'(count) and 'lon'(count) [RETURNED VALUES] new Rococo.geo.Mesh object
[NAME] Rococo.geo.Mesh.addBySec - add by latitude(second) and longitude(second) [TYPE] function [SYMPOSIS] Rococo.geo.Mesh.addBySec(sec); [ARGUMENTS] sec : operand, including 'lat'(second) adn 'lon'(second) [RETURNED VALUES] new Rococo.geo.Mesh object
[NAME] Rococo.geo.getMeshNumber - get mesh number ( or count ) from original mesh [TYPE] function [SYMPOSIS] Rococo.geo.Mesh.getMeshNumber(); [RETURNED VALUES] mesh number ( or count ) including 'lat'(integer) and 'lon'(integer) new Rococo.geo.Mesh object
[NAME] Rococo.jp.geo.JPMesh - Japan Local Mesh Code System [TYPE] constractor [SYMPOSIS] object = new Rococo.jp.geo.JPMesh(level,sec); [ARGUMENTS] level : Mesh System Level ( 1, 2 or 3 ) sec : potision hash including 'lat'(second) and 'lon'(second) [RETURNED VALUES] objects - succeeded null - failed
[NAME] Rococo.jp.geo.JPMesh.getMeshCode - get mesh code [TYPE] function [SYMPOSIS] object.getMeshCode(); [ARGUMENTS] object : Rococo.jp.geo.JPMesh object [RETURNED VALUES] string - JP mesh code
[NAME] Rococo.jp.geo.JPMesh.addByMeshCode - add by meshcode [TYPE] function [SYMPOSIS] object.addByMeshCode(meshcode); [ARGUMENTS] meshcode : meshcode array, meshcode[0] as 1st level to meshcode[2] as 3rd level, all of elements are hashes including 'lat'(second) and 'lon'(second) object : Rococo.jp.geo.JPMesh object [RETURNED VALUES] new Mesh object (not JPMeshCode)