<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: editor-plugin WireIt.BaseEditor (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://neyric.github.com/wireit" title="WireItLibrary">WireItLibrary</a></h1>
<h3>editor-plugin <span class="subtitle">0.6.0</span></h3>
<a href="./index.html" title="WireItLibrary">WireItLibrary</a>
> <a href="./module_editor-plugin.html" title="editor-plugin">editor-plugin</a>
> WireIt.BaseEditor
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">WireIt.BaseEditor</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<dl class="subclasses" rel="yui:subclasses">
<dt>Known Subclasses:</dt>
<dd>
<span rel="yui:subclass" resource="WireIt.WiringEditor.html">
<a href="WireIt.WiringEditor.html" property="yui:name" title="WireIt.WiringEditor">WireIt.WiringEditor</a>
</span>
</dd>
</dl>
<div class="summary description" property="yui:description">
The BaseEditor class provides a full page interface
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">WireIt.BaseEditor</strong>
<code>
(
options
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">options</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> (layoutOptions,propertiesFields,accordionViewParams)</span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="" rel="yui:property" resource="#property_alertPanel">
<h4><a name="property_alertPanel" property="yui:name">alertPanel</a>
- <code><span property="yui:type">{YAHOO.widget.Panel}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_defaultOptions">
<h4><a name="property_defaultOptions" property="yui:name">defaultOptions</a>
- <code><span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default options for the BaseEditor
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_el">
<h4><a name="property_el" property="yui:name">el</a>
- <code><span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Container DOM element
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_helpPanel">
<h4><a name="property_helpPanel" property="yui:name">helpPanel</a>
- <code><span property="yui:type">{YAHOO.widget.Panel}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_layout">
<h4><a name="property_layout" property="yui:name">layout</a>
- <code><span property="yui:type">{YAHOO.widget.Layout}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_options">
<h4><a name="property_options" property="yui:name">options</a>
- <code><span property="yui:type">{Object}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="" rel="yui:method" resource="#method_alert">
<h4>
<a name="method_alert">alert</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">alert</strong>
(
)
</code>
<div class="description" property="yui:description">
Displays a message
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isSaved">
<h4>
<a name="method_isSaved">isSaved</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">isSaved</strong>
(
)
</code>
<div class="description" property="yui:description">
Is saved ?
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_markSaved">
<h4>
<a name="method_markSaved">markSaved</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">markSaved</strong>
(
)
</code>
<div class="description" property="yui:description">
Hide the save indicator
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_markUnsaved">
<h4>
<a name="method_markUnsaved">markUnsaved</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">markUnsaved</strong>
(
)
</code>
<div class="description" property="yui:description">
Show the save indicator
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onHelp">
<h4>
<a name="method_onHelp">onHelp</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onHelp</strong>
(
)
</code>
<div class="description" property="yui:description">
Create a help panel
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onSave">
<h4>
<a name="method_onSave">onSave</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onSave</strong>
(
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_render">
<h4>
<a name="method_render">render</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">render</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the layout & panels
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderAlertPanel">
<h4>
<a name="method_renderAlertPanel">renderAlertPanel</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderAlertPanel</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the alert panel
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderButtons">
<h4>
<a name="method_renderButtons">renderButtons</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderButtons</strong>
(
)
</code>
<div class="description" property="yui:description">
Toolbar
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderHelpPanel">
<h4>
<a name="method_renderHelpPanel">renderHelpPanel</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderHelpPanel</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the help dialog
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderPropertiesAccordion">
<h4>
<a name="method_renderPropertiesAccordion">renderPropertiesAccordion</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderPropertiesAccordion</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the accordion using yui-accordion
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderPropertiesForm">
<h4>
<a name="method_renderPropertiesForm">renderPropertiesForm</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderPropertiesForm</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the properties form
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_renderSavedStatus">
<h4>
<a name="method_renderSavedStatus">renderSavedStatus</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">renderSavedStatus</strong>
(
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_save">
<h4>
<a name="method_save">save</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">save</strong>
(
)
</code>
<div class="description" property="yui:description">
Save method (empty)
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_setOptions">
<h4>
<a name="method_setOptions">setOptions</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">setOptions</strong>
(
options
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">options</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animations-plugin.html" title="animations-plugin">animations-plugin</a></li>
<li class=""><a href="module_composable-plugin.html" title="composable-plugin">composable-plugin</a></li>
<li class="selected"><a href="module_editor-plugin.html" title="editor-plugin">editor-plugin</a></li>
<li class=""><a href="module_inputex-plugin.html" title="inputex-plugin">inputex-plugin</a></li>
<li class=""><a href="module_layout-plugin.html" title="layout-plugin">layout-plugin</a></li>
<li class=""><a href="module_wireit.html" title="WireIt">WireIt</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="WireIt.BaseEditor.html" title="WireIt.BaseEditor">WireIt.BaseEditor</a></li>
<li class=""><a href="WireIt.FormContainer.html" title="WireIt.FormContainer">WireIt.FormContainer</a></li>
<li class=""><a href="WireIt.Group.html" title="WireIt.Group">WireIt.Group</a></li>
<li class=""><a href="WireIt.Grouper.html" title="WireIt.Grouper">WireIt.Grouper</a></li>
<li class=""><a href="WireIt.GroupUtils.html" title="WireIt.GroupUtils">WireIt.GroupUtils</a></li>
<li class=""><a href="WireIt.ModuleProxy.html" title="WireIt.ModuleProxy">WireIt.ModuleProxy</a></li>
<li class=""><a href="WireIt.RubberBand.html" title="WireIt.RubberBand">WireIt.RubberBand</a></li>
<li class=""><a href="WireIt.WiringEditor.html" title="WireIt.WiringEditor">WireIt.WiringEditor</a></li>
<li class=""><a href="WireIt.WiringEditor.adapters.Ajax.html" title="WireIt.WiringEditor.adapters.Ajax">WireIt.WiringEditor.adapters.Ajax</a></li>
<li class=""><a href="WireIt.WiringEditor.adapters.Gears.html" title="WireIt.WiringEditor.adapters.Gears">WireIt.WiringEditor.adapters.Gears</a></li>
<li class=""><a href="WireIt.WiringEditor.adapters.JsonRpc.html" title="WireIt.WiringEditor.adapters.JsonRpc">WireIt.WiringEditor.adapters.JsonRpc</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ajax.js.html" title="ajax.js">ajax.js</a></li>
<li class=""><a href="FormContainer.js.html" title="FormContainer.js">FormContainer.js</a></li>
<li class=""><a href="gears.js.html" title="gears.js">gears.js</a></li>
<li class=""><a href="Group.js.html" title="Group.js">Group.js</a></li>
<li class=""><a href="Grouper.js.html" title="Grouper.js">Grouper.js</a></li>
<li class=""><a href="GroupFormContainer.js.html" title="GroupFormContainer.js">GroupFormContainer.js</a></li>
<li class=""><a href="GroupUtils.js.html" title="GroupUtils.js">GroupUtils.js</a></li>
<li class=""><a href="json-rpc.js.html" title="json-rpc.js">json-rpc.js</a></li>
<li class=""><a href="ModuleProxy.js.html" title="ModuleProxy.js">ModuleProxy.js</a></li>
<li class=""><a href="rest-json.js.html" title="rest-json.js">rest-json.js</a></li>
<li class=""><a href="RubberBand.js.html" title="RubberBand.js">RubberBand.js</a></li>
<li class=""><a href="WiringEditor.js.html" title="WiringEditor.js">WiringEditor.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_alertPanel" title="alertPanel">alertPanel</a></li>
<li class=""><a href="#property_defaultOptions" title="defaultOptions">defaultOptions</a></li>
<li class=""><a href="#property_el" title="el">el</a></li>
<li class=""><a href="#property_helpPanel" title="helpPanel">helpPanel</a></li>
<li class=""><a href="#property_layout" title="layout">layout</a></li>
<li class=""><a href="#property_options" title="options">options</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><a href="#method_alert" title="alert">alert</a></li>
<li class=""><a href="#method_isSaved" title="isSaved">isSaved</a></li>
<li class=""><a href="#method_markSaved" title="markSaved">markSaved</a></li>
<li class=""><a href="#method_markUnsaved" title="markUnsaved">markUnsaved</a></li>
<li class=""><a href="#method_onHelp" title="onHelp">onHelp</a></li>
<li class=""><a href="#method_onSave" title="onSave">onSave</a></li>
<li class=""><a href="#method_render" title="render">render</a></li>
<li class=""><a href="#method_renderAlertPanel" title="renderAlertPanel">renderAlertPanel</a></li>
<li class=""><a href="#method_renderButtons" title="renderButtons">renderButtons</a></li>
<li class=""><a href="#method_renderHelpPanel" title="renderHelpPanel">renderHelpPanel</a></li>
<li class=""><a href="#method_renderPropertiesAccordion" title="renderPropertiesAccordion">renderPropertiesAccordion</a></li>
<li class=""><a href="#method_renderPropertiesForm" title="renderPropertiesForm">renderPropertiesForm</a></li>
<li class=""><a href="#method_renderSavedStatus" title="renderSavedStatus">renderSavedStatus</a></li>
<li class=""><a href="#method_save" title="save">save</a></li>
<li class=""><a href="#method_setOptions" title="setOptions">setOptions</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2010 Eric Abouaf All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"url": "WireIt.BaseEditor.html#method_alert", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "alert"}, {"url": "WireIt.BaseEditor.html#property_alertPanel", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "alertPanel"}, {"url": "WireIt.BaseEditor.html#property_defaultOptions", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "defaultOptions"}, {"url": "WireIt.BaseEditor.html#property_el", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "el"}, {"url": "WireIt.BaseEditor.html#property_helpPanel", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "helpPanel"}, {"url": "WireIt.BaseEditor.html#method_isSaved", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "isSaved"}, {"url": "WireIt.BaseEditor.html#property_layout", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "layout"}, {"url": "WireIt.BaseEditor.html#method_markSaved", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "markSaved"}, {"url": "WireIt.BaseEditor.html#method_markUnsaved", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "markUnsaved"}, {"url": "WireIt.BaseEditor.html#method_onHelp", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "onHelp"}, {"url": "WireIt.BaseEditor.html#method_onSave", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "onSave"}, {"url": "WireIt.BaseEditor.html#property_options", "access": "", "host": "WireIt.BaseEditor", "type": "property", "name": "options"}, {"url": "WireIt.BaseEditor.html#method_render", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "render"}, {"url": "WireIt.BaseEditor.html#method_renderAlertPanel", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderAlertPanel"}, {"url": "WireIt.BaseEditor.html#method_renderButtons", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderButtons"}, {"url": "WireIt.BaseEditor.html#method_renderHelpPanel", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderHelpPanel"}, {"url": "WireIt.BaseEditor.html#method_renderPropertiesAccordion", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderPropertiesAccordion"}, {"url": "WireIt.BaseEditor.html#method_renderPropertiesForm", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderPropertiesForm"}, {"url": "WireIt.BaseEditor.html#method_renderSavedStatus", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "renderSavedStatus"}, {"url": "WireIt.BaseEditor.html#method_save", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "save"}, {"url": "WireIt.BaseEditor.html#method_setOptions", "access": "", "host": "WireIt.BaseEditor", "type": "method", "name": "setOptions"}];
</script>
</body>
</html>