GeneratorComments_JavaScript.txt_normalized.txt

generatedfromldml/main/xmlxpathldml/calendars/calendar-gregorian
@classextdataassociationhasonerepresentsaonetooneassociationwithanothermodeltheownermodelisexpectedtohaveaforeignkeywhichreferencestheprimarykeyoftheassociatedmodelextdefineaddressextendextdatamodelfieldsnameidtypeintnamenumbertypestringnamestreettypestringnamecitytypestringnameziptypestringextdefinepersonextendextdatamodelfieldsnameidtypeintnamenametypestringnameaddress_idtypeintwecanusethehasoneshortcutonthemodeltocreateahasoneassociationassociationstypehasonemodeladdressintheexampleabovewehavecreatedmodelsforpeopleandaddressesandlinkedthemtogetherbysayingthateachpersonhasasingleaddressthisautomaticallylinkseachpersontoanaddressbasedonthepersonsaddress_idandprovidesnewfunctionsonthepersonmodel##generatedgetterfunctionthefirstfunctionthatisaddedtotheownermodelisagetterfunctionvarperson=newpersonidNUMBERaddress_idNUMBERnamejohnsmithpersongetaddressfunctionaddressoperationdosomethingwiththeaddressobjectalertaddressgetidalertsNUMBERthisthegetaddressfunctionwascreatedonthepersonmodelwhenwedefinedtheassociationthisusesthepersonsconfigured@linkextdataproxyproxyproxytoloadtheaddressasynchronouslycallingtheprovidedcallbackwhenithasloadedthenewgetaddressfunctionwillalsoacceptanobjectcontainingsuccessfailureandcallbackproperties-callbackwillalwaysbecalledsuccesswillonlybecallediftheassociatedmodelwasloadedsuccessfullyandfailurewillonlybecallediftheassociatiedmodelcouldnotbeloadedpersongetaddressreloadtrueforceareloadiftheownermodelisalreadycachedcallbackfunctionaddressoperationafunctionthatwillalwaysbecalledsuccessfunctionaddressoperationafunctionthatwillonlybecallediftheloadsucceededfailurefunctionaddressoperationafunctionthatwillonlybecallediftheloaddidnotsucceedscopethisoptionallypassinascopeobjecttoexecutethecallbacksinineachcaseabovethecallbacksarecalledwithtwoarguments-theassociatedmodelinstanceandthe@linkextdataoperationoperationobjectthatwasexecutedtoloadthatinstancetheoperationobjectisusefulwhentheinstancecouldnotbeloadedoncethegetterhasbeencalledonthemodelitwillbecachedifthegetteriscalledasecondtimetoforcethemodeltoreloadspecifyreloadtrueintheoptionsobject##generatedsetterfunctionthesecondgeneratedfunctionsetstheassociatedmodelinstance-ifonlyasingleargumentispassedtothesetterthenthefollowingtwocallsareidenticalthiscallpersonsetaddressNUMBERisequivalenttothiscallpersonsetaddress_idNUMBERaninstanceoftheownermodelcanalsobepassedasaparameterifwepassinasecondargumentthemodelwillbeautomaticallysavedandthesecondargumentpassedtotheownermodels@linkextdatamodel#savesavemethodpersonsetaddressNUMBERfunctionaddressoperationtheaddresshasbeensavedalertaddressgetaddress_idnowalertsNUMBERalternativesyntaxpersonsetaddressNUMBERcallbackfunctionaddressoperationafunctionthatwillalwaysbecalledsuccessfunctionaddressoperationafunctionthatwillonlybecallediftheloadsucceededfailurefunctionaddressoperationafunctionthatwillonlybecallediftheloaddidnotsucceedscopethisoptionallypassinascopeobjecttoexecutethecallbacksin##customisationassociationsreflectonthemodelstheyarelinkingtoautomaticallysetuppropertiessuchasthe@link#primarykeyand@link#foreignkeythesecanalternativelybespecifiedextdefinepersonfieldsassociationstypehasonemodeladdressprimarykeyunique_idforeignkeyaddr_idherewereplacedthedefaultprimarykeydefaultstoidandforeignkeycalculatedasaddress_idwithourownsettingsusuallythiswillnotbeneeded
@classextdatarecord<p>instancesofthisclassencapsulatebothrecord<em>definition</em>informationandrecord<em>value</em>informationforusein@linkextdatastoreobjectsoranycodewhichneedstoaccessrecordscachedinan@linkextdatastoreobject</p><p>constructorsforthisclassaregeneratedbypassinganarrayoffielddefinitionobjectsto@link#createinstancesareusuallyonlycreatedby@linkextdatareaderimplementationswhenprocessingunformatteddataobjects</p><p>notethataninstanceofarecordclassmayonlybelongtoone@linkextdatastorestoreatatimeinordertocopydatafromonestoretoanotherusethe@link#copymethodtocreateanexactcopyoftherecordandinsertthenewinstanceintotheotherstore</p><p>whenserializingarecordforsubmissiontotheserverbeawarethatitcontainsmanyprivatepropertiesandalsoareferencetoitsowningstorewhichinturnholdsreferencestoitsrecordsthismeansthatawholerecordmaynotbeencodedusing@linkextutiljsonencodeinsteadusethe<code>@link#data</code>and<code>@link#id</code>properties</p><p>recordobjectsgeneratedbythisconstructorinheritallthemethodsofextdatarecordlistedbelow</p>@constructor<p>thisconstructorshouldnotbeusedtocreaterecordobjectsinsteaduse@link#createtogenerateasubclassofextdatarecordconfiguredwithinformationaboutitsconstituentfields<p><p><b>thegeneratedconstructorhasthesamesignatureasthisconstructor</b></p>@paramobjectdataoptionalanobjectthepropertiesofwhichprovidevaluesforthenewrecordsfieldsifnotspecifiedthe<code>@linkextdatafield#defaultvaluedefaultvalue</code>foreachfieldwillbeassigned@paramobjectidoptionaltheidoftherecordtheidisusedbythe@linkextdatastoreobjectwhichownstherecordtoindexitscollectionofrecordsthereforethisidshouldbeuniquewithineachstoreifan<code>id</code>isnotspecifieda<b><code>@link#phantom</code></b>recordwillbecreatedwithan@link#recordidautomaticallygeneratedid
baseclassforanyextcomponentthatmaycontainothercomponentscontainershandlethebasicbehaviorofcontainingitemsnamelyaddinginsertingandremovingitemsthemostcommonlyusedcontainerclassesareextpanelpanelextwindowwindowandexttabpanelifyoudonotneedthecapabilitiesofferedbytheaforementionedclassesyoucancreatealightweightcontainertobeencapsulatedbyanhtmlelementtoyourspecificationsbyusingthe@linkextcomponent#autoelautoelconfigoptionthecodebelowillustrateshowtoexplicitlycreateacontainer@exampleexplicitlycreateacontainerextcreateextcontainercontainerlayouttypehboxwidthNUMBERrendertoextgetbodyborderNUMBERstylebordercolor#NUMBERborderstylesolidborderwidthNUMBERpxdefaultslabelwidthNUMBERimplicitlycreatecontainerbyspecifyingxtypextypedatefieldflexNUMBERstylepaddingNUMBERpxitemsxtypedatefieldnamestartdatefieldlabelstartdatextypedatefieldnameenddatefieldlabelenddate##layoutcontainerclassesdelegatetherenderingofchildcomponentstoalayoutmanagerclasswhichmustbeconfiguredintothecontainerusingthe`@link#layout`configurationpropertywheneitherspecifyingchild`@link#cfg-items`ofacontainerordynamically@link#method-addaddingcomponentstoacontainerremembertoconsiderhowyouwishthecontainertoarrangethosechildelementsandwhetherthosechildelementsneedtobesizedusingoneofextsbuilt-in`@link#layout`schemesbydefaultcontainersusethe@linkextlayoutcontainerautoautoschemewhichonlyrenderschildcomponentsappendingthemoneaftertheotherinsidethecontaineranddoesnotapplyanysizingatallacommonmistakeiswhenadeveloperneglectstospecifya`@link#layout`egwidgetslikegridpanelsortreepanelsareaddedtocontainersforwhichno`@link#layout`hasbeenspecifiedifacontainerislefttousethedefault@linkextlayoutcontainerautoautoschemenoneofitschildcomponentswillberesizedorchangedinanywaywhenthecontainerisresizedcertainlayoutmanagersallowdynamicadditionofchildcomponentsthosethatdoincludeextlayoutcontainercardextlayoutcontaineranchorextlayoutcontainervboxextlayoutcontainerhboxandextlayoutcontainertableforexamplecreatethegridpanelvarmynewgrid=extcreateextgridpanelstoremystoreheadersmyheaderstitleresultsthetitlebecomesthetitleofthetabmytabpaneladdmynewgrid@linkexttabpanelimplicitlyuses@linkextlayoutcontainercardcardmytabpanel@linkexttabpanel#setactivetabsetactivetabmynewgridtheexampleaboveaddsanewlycreatedgridpaneltoatabpanelnotethatatabpaneluses@linkextlayoutcontainercardasitslayoutmanagerwhichmeansallitschilditemsaresizedto@linkextlayoutcontainerfitfitexactlyintoitsclientarea_overnestingisacommonproblem_anexampleofovernestingoccurswhenagridpanelisaddedtoatabpanelbywrappingthegridpanel_inside_awrappingpanelthathasno`@link#layout`specifiedandthenaddthatwrappingpaneltothetabpanelthepointtorealizeisthatagridpanelisacomponentwhichcanbeaddeddirectlytoacontainerifthewrappingpanelhasno`@link#layout`configurationthentheovernestedgridpanelwillnotbesizedasexpected##addingviaremoteconfigurationaserversidescriptcanbeusedtoaddcomponentswhicharegenerateddynamicallyontheserveranexampleofaddingagridpaneltoatabpanelwherethegridpanelisgeneratedbytheserverbasedoncertainparametersexecuteanajaxrequesttoinvokeserversidescriptextajaxrequesturlgen-invoice-gridphpsendadditionalparameterstoinstructserverscriptparamsstartdateextgetcmpstart-dategetvalueenddateextgetcmpend-dategetvalueprocesstheresponseobjecttoaddittothetabpanelsuccessfunctionxhrvarnewcomponent=evalxhrresponsetextseediscussionbelowmytabpaneladdnewcomponentaddthecomponenttothetabpanelmytabpanelsetactivetabnewcomponentfailurefunctionextmsgalertgridcreatefailedservercommunicationfailuretheserverscriptneedstoreturnajsonrepresentationofaconfigurationobjectwhichwhendecodedwillreturnaconfigobjectwithan@linkextcomponent#xtypextypetheservermightreturnthefollowingjsonxtypegridtitleinvoicereportstoremodelinvoiceproxytypeajaxurlget-invoice-dataphpreadertypejsonrecordtransactionidpropertyidtotalrecordstotalautoloadparamsstartdateNUMBER/NUMBER/YEARenddateNUMBER/NUMBER/YEARheadersheadercustomerwidthNUMBERdataindexcustomersortabletrueheaderinvoicenumberwidthNUMBERdataindexinvnosortabletrueheaderinvoicedatewidthNUMBERdataindexdaterendererextutilformatdaterenderermdysortabletrueheadervaluewidthNUMBERdataindexvaluerendererusmoneysortabletruewhentheabovecodefragmentispassedthroughthe`eval`functioninthesuccesshandleroftheajaxrequesttheresultwillbeaconfigobjectwhichwhenaddedtoacontainerwillcauseinstantiationofagridpanelbesurethatthecontainerisconfiguredwithalayoutwhichsizesandpositionsthechilditemstoyourrequirementsnotesincethecodeaboveis_generated_byaserverscriptthe`autoload`paramsforthestoretheuserspreferreddateformatthemetadatatoallowgenerationofthemodellayoutandthecolumnmodelcanallbegeneratedintothecodesincetheseareallknownontheserver
generatedfromlib/ksscoffee
generatedbynpmpleasedonttouch
@classextcontainer@extendsextboxcomponent<p>baseclassforany@linkextboxcomponentthatmaycontainothercomponentscontainershandlethebasicbehaviorofcontainingitemsnamelyaddinginsertingandremovingitems</p><p>themostcommonlyusedcontainerclassesare@linkextpanel@linkextwindowand@linkexttabpanelifyoudonotneedthecapabilitiesofferedbytheaforementionedclassesyoucancreatealightweightcontainertobeencapsulatedbyanhtmlelementtoyourspecificationsbyusingthe<code><b>@linkextcomponent#autoelautoel</b></code>configoptionthisisausefultechniquewhencreatingembedded@linkextlayoutcolumnlayoutcolumnlayoutsinside@linkextformformpanelformpanelsforexample</p><p>thecodebelowillustratesbothhowtoexplicitlycreateacontainerandhowtoimplicitlycreateoneusingthe<b><code>container</code></b>xtype<pre><code>explicitlycreateacontainervarembeddedcolumns=newextcontainerautoeldivthisisthedefaultlayoutcolumndefaultsimplicitlycreatecontainerbyspecifyingxtypextypecontainerautoeldivthisisthedefaultlayoutformcolumnwidthVERSIONstylepaddingNUMBERpxthetwoitemsbelowwillbeextcontainerseachencapsulatedbya&ltdiv>elementitemsitemsxtypedatefieldnamestartdatefieldlabelstartdateitemsxtypedatefieldnameenddatefieldlabelenddate</code></pre></p><p><u><b>layout</b></u></p><p>containerclassesdelegatetherenderingofchildcomponentstoalayoutmanagerclasswhichmustbeconfiguredintothecontainerusingthe<code><b>@link#layout</b></code>configurationproperty</p><p>wheneitherspecifyingchild<code>@link#items</code>ofacontainerordynamically@link#addaddingcomponentstoacontainerremembertoconsiderhowyouwishthecontainertoarrangethosechildelementsandwhetherthosechildelementsneedtobesizedusingoneofextsbuilt-in<b><code>@link#layout</code></b>schemesbydefaultcontainersusethe@linkextlayoutcontainerlayoutcontainerlayoutschemewhichonlyrenderschildcomponentsappendingthemoneaftertheotherinsidethecontainerand<b>doesnotapplyanysizing</b>atall</p><p>acommonmistakeiswhenadeveloperneglectstospecifya<b><code>@link#layout</code></b>egwidgetslikegridpanelsortreepanelsareaddedtocontainersforwhichno<code><b>@link#layout</b></code>hasbeenspecifiedifacontainerislefttousethedefault@linkextlayoutcontainerlayoutcontainerlayoutschemenoneofitschildcomponentswillberesizedorchangedinanywaywhenthecontainerisresized</p><p>certainlayoutmanagersallowdynamicadditionofchildcomponentsthosethatdoinclude@linkextlayoutcardlayout@linkextlayoutanchorlayout@linkextlayoutformlayoutand@linkextlayouttablelayoutforexample<pre><code>createthegridpanelvarmynewgrid=newextgridgridpanelstoremystorecolumnsmycolumnmodeltitleresultsthetitlebecomesthetitleofthetabmytabpaneladdmynewgrid@linkexttabpanelimplicitlyuses@linkextlayoutcardlayoutcardlayoutmytabpanel@linkexttabpanel#setactivetabsetactivetabmynewgrid</code></pre></p><p>theexampleaboveaddsanewlycreatedgridpaneltoatabpanelnotethatatabpaneluses@linkextlayoutcardlayoutasitslayoutmanagerwhichmeansallitschilditemsaresizedto@linkextlayoutfitlayoutfitexactlyintoitsclientarea<p><b><u>overnestingisacommonproblem</u></b>anexampleofovernestingoccurswhenagridpanelisaddedtoatabpanelbywrappingthegridpanel<i>inside</i>awrappingpanelthathasno<code><b>@link#layout</b></code>specifiedandthenaddthatwrappingpaneltothetabpanelthepointtorealizeisthatagridpanel<b>is</b>acomponentwhichcanbeaddeddirectlytoacontainerifthewrappingpanelhasno<code><b>@link#layout</b></code>configurationthentheovernestedgridpanelwillnotbesizedasexpected<p><p><u><b>addingviaremoteconfiguration</b></u></p><p>aserversidescriptcanbeusedtoaddcomponentswhicharegenerateddynamicallyontheserveranexampleofaddingagridpaneltoatabpanelwherethegridpanelisgeneratedbytheserverbasedoncertainparameters</p><pre><code>executeanajaxrequesttoinvokeserversidescriptextajaxrequesturlgen-invoice-gridphpsendadditionalparameterstoinstructserverscriptparamsstartdateextgetcmpstart-dategetvalueenddateextgetcmpend-dategetvalueprocesstheresponseobjecttoaddittothetabpanelsuccessfunctionxhrvarnewcomponent=evalxhrresponsetextseediscussionbelowmytabpaneladdnewcomponentaddthecomponenttothetabpanelmytabpanelsetactivetabnewcomponentfailurefunctionextmsgalertgridcreatefailedservercommunicationfailure</code></pre><p>theserverscriptneedstoreturnanexecutablejavascriptstatementwhichwhenprocessedusing<code>eval</code>willreturneitheraconfigobjectwithan@linkextcomponent#xtypextypeoraninstantiatedcomponenttheservermightreturnthisforexample</p><pre><code>functionfunctionformatdatevaluereturnvaluevaluedateformatmdyvarstore=newextdatastoreurlget-invoice-dataphpbaseparamsstartdateNUMBER/NUMBER/YEARenddateNUMBER/NUMBER/YEARreadernewextdatajsonreaderrecordtransactionidpropertyidtotalrecordstotalcustomerinvnonamedatetypedatedateformatm/d/ynamevaluetypefloatvargrid=newextgridgridpaneltitleinvoicereportbbarnewextpagingtoolbarstorestorestorecolumnsheadercustomerwidthNUMBERdataindexcustomersortabletrueheaderinvoicenumberwidthNUMBERdataindexinvnosortabletrueheaderinvoicedatewidthNUMBERdataindexdaterendererformatdatesortabletrueheadervaluewidthNUMBERdataindexvaluerendererusmoneysortabletruestoreloadreturngridreturninstantiatedcomponent</code></pre><p>whentheabovecodefragmentispassedthroughthe<code>eval</code>functioninthesuccesshandleroftheajaxrequestthecodeisexecutedbythejavascriptprocessorandtheanonymousfunctionrunsandreturnstheinstantiatedgridcomponent</p><p>notesincethecodeaboveis<i>generated</i>byaserverscriptthe<code>baseparams</code>forthestorethemetadatatoallowgenerationoftherecordlayoutandthecolumnmodelcanallbegeneratedintothecodesincetheseareallknownontheserver</p>@xtypecontainer
generatedbycoffeescriptVERSION
arrayofpixellocationstheelementwillsnaptoifwespecifiedaverticalgraduation/intervalthisarrayisgeneratedautomaticallywhenyoudefineatickinterval@propertyyticks@typeint
jisongeneratedlexer
generatedfromldml/main/xmlxpathldml/numbers
mitlicenseURLthisfileisgeneratedby`cakebuild`donotedititbyhand
@authoredspencer@classextdataassociationbelongstorepresentsamanytooneassociationwithanothermodeltheownermodelisexpectedtohaveaforeignkeywhichreferencestheprimarykeyoftheassociatedmodelextdefinecategoryextendextdatamodelfieldsnameidtypeintnamenametypestringextdefineproductextendextdatamodelfieldsnameidtypeintnamecategory_idtypeintnamenametypestringwecanusethebelongstoshortcutonthemodeltocreateabelongstoassociationassociationstypebelongstomodelcategoryintheexampleabovewehavecreatedmodelsforproductsandcategoriesandlinkedthemtogetherbysayingthateachproductbelongstoacategorythisautomaticallylinkseachproducttoacategorybasedontheproductscategory_idandprovidesnewfunctionsontheproductmodel##generatedgetterfunctionthefirstfunctionthatisaddedtotheownermodelisagetterfunctionvarproduct=newproductidNUMBERcategory_idNUMBERnamesneakersproductgetcategoryfunctioncategoryoperationdosomethingwiththecategoryobjectalertcategorygetidalertsNUMBERthisthegetcategoryfunctionwascreatedontheproductmodelwhenwedefinedtheassociationthisusesthecategorysconfigured@linkextdataproxyproxyproxytoloadthecategoryasynchronouslycallingtheprovidedcallbackwhenithasloadedthenewgetcategoryfunctionwillalsoacceptanobjectcontainingsuccessfailureandcallbackproperties-callbackwillalwaysbecalledsuccesswillonlybecallediftheassociatedmodelwasloadedsuccessfullyandfailurewillonlybecallediftheassociatiedmodelcouldnotbeloadedproductgetcategoryreloadtrueforceareloadiftheownermodelisalreadycachedcallbackfunctioncategoryoperationafunctionthatwillalwaysbecalledsuccessfunctioncategoryoperationafunctionthatwillonlybecallediftheloadsucceededfailurefunctioncategoryoperationafunctionthatwillonlybecallediftheloaddidnotsucceedscopethisoptionallypassinascopeobjecttoexecutethecallbacksinineachcaseabovethecallbacksarecalledwithtwoarguments-theassociatedmodelinstanceandthe@linkextdataoperationoperationobjectthatwasexecutedtoloadthatinstancetheoperationobjectisusefulwhentheinstancecouldnotbeloadedoncethegetterhasbeencalledonthemodelitwillbecachedifthegetteriscalledasecondtimetoforcethemodeltoreloadspecifyreloadtrueintheoptionsobject##generatedsetterfunctionthesecondgeneratedfunctionsetstheassociatedmodelinstance-ifonlyasingleargumentispassedtothesetterthenthefollowingtwocallsareidenticalthiscallproductsetcategoryNUMBERisequivalenttothiscallproductsetcategory_idNUMBERaninstanceoftheownermodelcanalsobepassedasaparameterifwepassinasecondargumentthemodelwillbeautomaticallysavedandthesecondargumentpassedtotheownermodels@linkextdatamodel#savesavemethodproductsetcategoryNUMBERfunctionproductoperationtheproducthasbeensavedalertproductgetcategory_idnowalertsNUMBERalternativesyntaxproductsetcategoryNUMBERcallbackfunctionproductoperationafunctionthatwillalwaysbecalledsuccessfunctionproductoperationafunctionthatwillonlybecallediftheloadsucceededfailurefunctionproductoperationafunctionthatwillonlybecallediftheloaddidnotsucceedscopethisoptionallypassinascopeobjecttoexecutethecallbacksin##customisationassociationsreflectonthemodelstheyarelinkingtoautomaticallysetuppropertiessuchasthe@link#primarykeyand@link#foreignkeythesecanalternativelybespecifiedextdefineproductfieldsassociationstypebelongstomodelcategoryprimarykeyunique_idforeignkeycat_idherewereplacedthedefaultprimarykeydefaultstoidandforeignkeycalculatedascategory_idwithourownsettingsusuallythiswillnotbeneeded
jisongeneratedparser
@propertynumberxticksarrayofpixellocationstheelementwillsnaptoifwespecifiedahorizontalgraduation/intervalthisarrayisgeneratedautomaticallywhenyoudefineatickinterval
arrayofpixellocationstheelementwillsnaptoifwespecifiedahorizontalgraduation/intervalthisarrayisgeneratedautomaticallywhenyoudefineatickinterval@propertyxticks@typeint
generatedfromldml/main/xmlxpathldml/numbers/currencies
@cfgobjectconfiglistofconfigurationoptionswiththeirdefaultvaluesforwhichautomaticallyaccessormethodsaregeneratedforexampleextdefinesmartphoneconfighastouchscreenfalseoperatingsystemotherpriceNUMBERconstructorfunctioncfgthisinitconfigcfgvariphone=newsmartphonehastouchscreentrueoperatingsystemiosiphonegetpriceNUMBERiphonegetoperatingsystemiosiphonegethastouchscreentrue
editbelowthislineatyourownrisk
@propertynumberyticksarrayofpixellocationstheelementwillsnaptoifwespecifiedaverticalgraduation/intervalthisarrayisgeneratedautomaticallywhenyoudefineatickinterval
generatedfromldml/main/xmlxpathldml/calendars/calendar-islamic-civil