Blame | Last modification | View Log | RSS feed
/*
* Ext JS Library 2.0.2
* Copyright(c) 2006-2008, Ext JS, LLC.
* licensing@extjs.com
*
* http://extjs.com/license
*/
/**
* @class Ext.layout.FormLayout
* @extends Ext.layout.AnchorLayout
* <p>This is a layout specifically designed for creating forms.
* This class can be extended or created via the layout:'form' {@link Ext.Container#layout} config,
* and should generally not need to be created directly via the new keyword. However, when used in an application,
* it will usually be preferrable to use a {@link Ext.form.FormPanel} (which automatically uses FormLayout as its layout
* class) since it also provides built-in functionality for loading, validating and submitting the form.</p>
* <p>Note that when creating a layout via config, the layout-specific config properties must be passed in via
* the {@link Ext.Container#layoutConfig} object which will then be applied internally to the layout. The container
* using the FormLayout can also supply the following form-specific config properties which will be applied by the layout:
* <ul>
* <li><b>hideLabels</b>: (Boolean) True to hide field labels by default (defaults to false)</li>
* <li><b>itemCls</b>: (String) A CSS class to add to the div wrapper that contains each field label
* and field element (the default class is 'x-form-item' and itemCls will be added to that)</li>
* <li><b>labelAlign</b>: (String) The default label alignment. The default value is empty string ''
* for left alignment, but specifying 'top' will align the labels above the fields.</li>
* <li><b>labelPad</b>: (Number) The default padding in pixels for field labels (defaults to 5). labelPad only
* applies if labelWidth is also specified, otherwise it will be ignored.</li>
* <li><b>labelWidth</b>: (Number) The default width in pixels of field labels (defaults to 100)</li>
* </ul></p>
* <p>Any type of components can be added to a FormLayout, but items that inherit from {@link Ext.form.Field}
* can also supply the following field-specific config properties:
* <ul>
* <li><b>clearCls</b>: (String) The CSS class to apply to the special clearing div rendered directly after each
* form field wrapper (defaults to 'x-form-clear-left')</li>
* <li><b>fieldLabel</b>: (String) The text to display as the label for this field (defaults to '')</li>
* <li><b>hideLabel</b>: (Boolean) True to hide the label and separator for this field (defaults to false).</li>
* <li><b>itemCls</b>: (String) A CSS class to add to the div wrapper that contains this field label
* and field element (the default class is 'x-form-item' and itemCls will be added to that). If supplied,
* itemCls at the field level will override the default itemCls supplied at the container level.</li>
* <li><b>labelSeparator</b>: (String) The separator to display after the text of the label for this field
* (defaults to a colon ':' or the layout's value for {@link #labelSeparator}). To hide the separator use empty string ''.</li>
* <li><b>labelStyle</b>: (String) A CSS style specification string to add to the field label for this field
* (defaults to '' or the layout's value for {@link #labelStyle}).</li>
* </ul>
* Example usage:</p>
* <pre><code>
// Required if showing validation messages
Ext.QuickTips.init();
// While you can create a basic Panel with layout:'form', practically
// you should usually use a FormPanel to also get its form functionality
// since it already creates a FormLayout internally.
var form = new Ext.form.FormPanel({
labelWidth: 75,
title: 'Form Layout',
bodyStyle:'padding:15px',
width: 350,
labelPad: 10,
defaultType: 'textfield',
defaults: {
// applied to each contained item
width: 230,
msgTarget: 'side'
},
layoutConfig: {
// layout-specific configs go here
labelSeparator: ''
},
items: [{
fieldLabel: 'First Name',
name: 'first',
allowBlank: false
},{
fieldLabel: 'Last Name',
name: 'last'
},{
fieldLabel: 'Company',
name: 'company'
},{
fieldLabel: 'Email',
name: 'email',
vtype:'email'
}
],
buttons: [{
text: 'Save'
},{
text: 'Cancel'
}]
});
</code></pre>
*/
Ext.layout.FormLayout = Ext.extend(Ext.layout.AnchorLayout, {
/**
* @cfg {String} labelStyle
* A CSS style specification string to add to each field label in this layout (defaults to '').
*/
/**
* @cfg {String} elementStyle
* A CSS style specification string to add to each field element in this layout (defaults to '').
*/
/**
* @cfg {String} labelSeparator
* The standard separator to display after the text of each form label (defaults to a colon ':'). To turn off
* separators for all fields in this layout by default specify empty string '' (if the labelSeparator value is
* explicitly set at the field level, those will still be displayed).
*/
labelSeparator : ':',
// private
getAnchorViewSize : function(ct, target){
return ct.body.getStyleSize();
},
// private
setContainer : function(ct){
Ext.layout.FormLayout.superclass.setContainer.call(this, ct);
if(ct.labelAlign){
ct.addClass('x-form-label-'+ct.labelAlign);
}
if(ct.hideLabels){
this.labelStyle = "display:none";
this.elementStyle = "padding-left:0;";
this.labelAdjust = 0;
}else{
this.labelSeparator = ct.labelSeparator || this.labelSeparator;
ct.labelWidth = ct.labelWidth || 100;
if(typeof ct.labelWidth == 'number'){
var pad = (typeof ct.labelPad == 'number' ? ct.labelPad : 5);
this.labelAdjust = ct.labelWidth+pad;
this.labelStyle = "width:"+ct.labelWidth+"px;";
this.elementStyle = "padding-left:"+(ct.labelWidth+pad)+'px';
}
if(ct.labelAlign == 'top'){
this.labelStyle = "width:auto;";
this.labelAdjust = 0;
this.elementStyle = "padding-left:0;";
}
}
if(!this.fieldTpl){
// the default field template used by all form layouts
var t = new Ext.Template(
'<div class="x-form-item {5}" tabIndex="-1">',
'<label for="{0}" style="{2}" class="x-form-item-label">{1}{4}</label>',
'<div class="x-form-element" id="x-form-el-{0}" style="{3}">',
'</div><div class="{6}"></div>',
'</div>'
);
t.disableFormats = true;
t.compile();
Ext.layout.FormLayout.prototype.fieldTpl = t;
}
},
// private
renderItem : function(c, position, target){
if(c && !c.rendered && c.isFormField && c.inputType != 'hidden'){
var args = [
c.id, c.fieldLabel,
c.labelStyle||this.labelStyle||'',
this.elementStyle||'',
typeof c.labelSeparator == 'undefined' ? this.labelSeparator : c.labelSeparator,
(c.itemCls||this.container.itemCls||'') + (c.hideLabel ? ' x-hide-label' : ''),
c.clearCls || 'x-form-clear-left'
];
if(typeof position == 'number'){
position = target.dom.childNodes[position] || null;
}
if(position){
this.fieldTpl.insertBefore(position, args);
}else{
this.fieldTpl.append(target, args);
}
c.render('x-form-el-'+c.id);
}else {
Ext.layout.FormLayout.superclass.renderItem.apply(this, arguments);
}
},
// private
adjustWidthAnchor : function(value, comp){
return value - (comp.isFormField ? (comp.hideLabel ? 0 : this.labelAdjust) : 0);
},
// private
isValidParent : function(c, target){
return true;
}
/**
* @property activeItem
* @hide
*/
});
Ext.Container.LAYOUTS['form'] = Ext.layout.FormLayout;