formitem.js

javascript 很酷的类库

    pickerIconHSpace:0,
    
    //> @attr formItem.pickerIconDefaults (object : null : [IRWA])
    // Block of default properties to apply to the pickerIcon for this widget.
    // Intended for class-level customization: To modifying this value we recommend using
    // +link{isc.changeDefaults()} rather than directly assigning a value to the property.
    // @visibility pickerIcon
    //< 
    
    //> @attr formItem.pickerIconProperties (object : null : [IRWA])
    // If +link{formItem.showPickerIcon} is true for this item, this block of properties will
    // be applied to the pickerIcon. Allows for advanced customization of this icon.
    // @visibility pickerIcon
    //<
    
    //>@attr formItem.pickerIconSrc   (string : "" : [IRWA])
    // If +link{formItem.showPickerIcon} is true for this item, this property governs the
    // src of the picker icon image to be displayed.
    // @visibility pickerIcon
    //<
    pickerIconSrc:"[SKIN]/DynamicForm/pickerIcon.gif",
    
    //> @attr formItem.pickerIconWidth (number : null : [IRWA])
    // If +link{formItem.showPickerIcon} is true for this item, this property governs the
    // size of the picker icon. If unset picker icon will be sized as a square to fit in the
    // avaliable height for the icon.
    // @visibility pickerIcon
    //<
        
    //> @attr formItem.pickerIconHeight (number : null : [IRWA])
    // If +link{formItem.showPickerIcon} is true for this item, this property governs the
    // size of the picker icon. If unset picker icon will be sized as a square to fit in the
    // avaliable height for the icon.
    // @visibility pickerIcon
    //<
    
   	//> @attr	formItem.picker		(Canvas : null : [IRW])
    //
    // This is the component that will be displayed when formItem.showPicker() is called.  This is a
    // a component that helps a user pick a value or set of values.  If not specified, one will be
    // created using the default configuration.  See +link{attr:FormItem.pickerConstructor}
    // and +link{attr:FormItem.pickerProperties}
    //
    //  @visibility experimental
	//<

   	//> @attr	formItem.pickerConstructor		(String : null : [IRW])
    //
    // Class name of the picker to be created.
    //
    //  @visibility experimental
	//<
    
  	//> @attr	formItem.pickerProperties		(Object : {} : [IRW])
    //
    // Default properties for the picker.
    //
    //  @visibility experimental
	//<
    
    //

    // Validation
	// -----------------------------------------------------------------------------------------

    //> @attr   formItem.validators     (Array of Validator : null : IR)
    // Validators for this form item.  
    // <P>
    // <b>Note:</b> these validators will only be run on the client; to
    // do real client-server validation, validators must be specified on the DataSource.
    // @visibility external
    //<

    //> @attr   formItem.required       (boolean : false : [IR])
    // Whether a non-empty value is required for this field to pass validation.
    // <BR>
    // <b>Note:</b> if specified on a FormItem, <code>required</code> is only enforced on the
    // client.  <code>required</code> should generally be specified on a
    // +link{class:DataSourceField}.
    //
    // @group validation
    // @visibility external
    // @example formShowAndHide
    //<

    // Status
	// -----------------------------------------------------------------------------------------
    
    //>	@attr	formItem.visible		(boolean : true : IRW)
	// Whether this item is currently visible.
    // <P>
    // <code>visible</code> can only be set on creation.  After creation, use
    // +link{formItem.show()} and +link{formItem.hide()} to manipulate visibility.
    //
	// @group	appearance
    // @visibility external
	//<
	visible:true,

    //>	@attr	formItem.alwaysTakeSpace    (boolean : false : IRW)
	// If this form item is not visible, should they form it is contained in re-layout to
    // take advantage of the additional space, or should it continue to flow as if the
    // item were visible.  Set to true to have the form continue to flow around the item
    // even if it's not written out.
    //
	// @group	appearance
    // @visibility internal
	//<

	//>	@attr	formItem.disabled		(boolean : false : IRW)
	// Whether this item is disabled.  Can be updated at runtime via the <code>setDisabled()</code>
    // method.  Note that if the widget containing this formItem is disabled, the formItem will
    // behave in a disabled manner regardless of the setting of the item.disabled property.
    // <p>
    // Note that not all items can be disabled, and not all browsers show an obvious disabled style
    // for native form elements.
	//		@group	appearance
    //      @setter FormItem.setDisabled()
    //      @see FormItem.setDisabled()
    // @visibility external
    // @example fieldEnableDisable
	//<

    // Keyboard handling
	// -----------------------------------------------------------------------------------------
    
    //>@attr formItem.canFocus  (boolean : null : IRWA)
    // Is this form item focusable? 
    //<
    // If not set focusability is determined by whether this item has a data element by default.
    // If set to true, and this item has no data element we write out HTML to allow focus
    // on the item's text-box.
    
    
    //>	@attr	formItem.accessKey  (keyChar : null : IRW)
    //      AccessKey - a keyboard shortcut to trigger a form item's default behavior.<br>
    //      Note: Alt+ (or in Moz Firefox 2.0 and above, Shift+Alt+) the specified key will 
    //      trigger the form item's default behavior.
    //		@group	focus
    // @visibility external
    //<
    
    accessKey:null,                                        
    
    //>	@attr formItem.tabIndex		(integer : null : IRW)
    // tabIndex for the form item within the form.  Auto-assigned if not specified.<br>
    // Note: This controls the tab order within the form.
    // <P>
    // To specify the tabindex of an item within the page as a whole (not just this form), use
    // globalTabIndex instead.
    //
    //  @visibility external
    //  @group focus
    //<                          
    //tabIndex:null,

    //>	@attr formItem.globalTabIndex		(integer : null : IRWA)
    // TabIndex for the form item within the page. Takes presidence over any local tab index
    // specified as +link{tabIndex,item.tabIndex}.
    //  @visibility external
    //  @group focus
    //<                          
    //globalTabIndex:null,
    
    //> @attr   formItem.selectOnFocus  (boolean : null : IRW)
    // If this property is set to true, whenever this item is given focus programmatically 
    // (see +link{DynamicForm.focusInItem()}), all text within the item will be selected.<br>
    // If false, the selection is not modified on focus - any previous selection within the
    // item will be restored.<br>
    // If unset, this property is derived from +link{DynamicForm.selectOnFocus}
	// @group focus	
    // @visibility internal
	//<
    // Exposed on TextItem and TextAreaItem directly since it won't apply to other items.
    
    //          If defined, this overrides the 'selectOnFocus' behavior for this element.<br>
    //          if true, we select a field upon focusing into it,<br>
    //          if false, we merely place the insertion pointer into the field.<br>
    //          By Default this behavior is defined by the form's 'selectOnFocus' property value.
    //      @group  eventHandling, focus	
    //      @see    attr:dynamicForm.selectOnFocus
    //<
    
    
    //> @attr   formItem.changeOnKeypress   (boolean : true : RW)
    //  Should this form item fire its changeHandler (and store its value in the form) on every
    //  keypress.
    //  Set to false to suppress the 'change' handler fired (and the value stored) on every keypress.
    //  <br>
    //  Note: If false, the value returned by 'getValue()' will not reflect the value displayed in
    //  the form item element as long as focus is in the form item element.
    // 
    //      @group  eventHandling, values
    //<    
    changeOnKeypress:true,
    
    // maintainSelectionOnTransform
    // Internal, but non obfuscated property.
    // Ensure selection is maintained if:
    // - the value is reverted due to a change handler returning false during typing
    // - the value is modified during typing, but either the value is unchanged except for
    //   case shifting, or the entire value was selected before typing.
    // If this causes a performance hit in any cases, we can disable it.
    maintainSelectionOnTransform:true,
    
    
    //> @attr   formItem.dirtyOnKeyDown (boolean : true : RW)
    //  Should this form item get marked as dirty on every keyDown?
    //  @group  eventHandling, values
    //<    
    dirtyOnKeyDown:true, 

    // Titles
	// --------------------------------------------------------------------------------------------
    //>	@attr	formItem.showTitle		(boolean : true : IRW)
	// Should we show a title cell for this formItem?
    // <p>
    // Note: the default value of this attribute is overridden by some subclasses.
    //
	// @group title
    // @visibility external
	//<
	showTitle:true,
    
    //>	@attr	formItem.titleOrientation		(TitleOrientation : isc.Canvas.LEFT : IRW)
    // On which side of this item should the title be placed.  +link{type:TitleOrientation}
    // lists valid options.
    // <P>
    // Note that titles on the left or right take up a cell in tabular
    // +link{group:formLayout,form layouts}, but titles on top do not.
    // 
	// @group title
    // @see DynamicForm.titleOrientation
    // @visibility external
	//<
//	titleOrientation:isc.Canvas.LEFT,	// dynamically defaulted in DynamicForm

	//>	@attr	formItem.titleAlign		(Alignment : null : IRW)
	// Alignment of this item's title in its cell.
    // <p>
	// If null, dynamically set according to text direction.
	// @group title
    // @visibility external
	//<

    //> @attr formItem.clipTitle (boolean : null : [IRW])
    // If the title for this form item is showing, and is too large for the available space
    // should the title be clipped?<br>
    // Null by default - if set to true or false, overrides the <code>clipItemTitles</code> 
    // setting at the DynamicForm level.
    //<
//    clipTitle:null,
    
    //> @attr formItem.wrapTitle (boolean : null : [IRW])
    // If specified determines whether this items title should wrap.
    // Overrides +link{DynamicForm.wrapItemTitles,wrapItemTitles} at the DynamicForm level.
    // @group title
    // @visibility external
    //<
//    wrapTitle:null,

    // Change handling
	// --------------------------------------------------------------------------------------------

	//>	@attr	formItem.redrawOnChange		(boolean : false : IRW)
	// If true, this item will cause the entire form to be redrawn
	// when the item's "elementChanged" event is done firing
	//		@group changeHandling
	//<

	//>	@attr	formItem.validateOnChange	(boolean : false : IRW)
	// If true, form items will be validated when each item's "change" handler is fired
	// as well as when the entire form is submitted or validated.
    // <p>
	// Note that this property can also be set at the form, level;
	// If true at either level the valiator will be fired on change - displaying errors and
    // rejecting the change on validation failure.
	// @group changeHandling
    // @visibility external
    // @see DynamicForm.validateOnChange
	//<	
    

	//>	@attr	formItem.changeOnBlur		(boolean : false : IRWA)
	// If true, this item will fire it's elementChanged message on BLUR in a field (eg: when the
    // user tabs through without making changes as well as when they actually change something), if
    // false, the message will only fire when the field is actually changed.  This is useful for
    // fields that do validation/value setting on change (such as the TimeItem), to work around a
    // bug in IE where the change event doesn't always fire correctly when you manually set the
    // value of the field in its ONCHANGE handler.  Note that it is not recommended that you set
    // both changeOnBlur==true AND redrawOnChange==true, as this will cause the form to redraw every
    // time you tab through that item.
	//		@group changeHandling
	//<
    

    // Size and Layout
	// --------------------------------------------------------------------------------------------
    //>	@attr	formItem.width		(number : "*" : IRW)
	// By default, items take up the entire width of their cell
	// @group formLayout
    // @visibility external
    // @example columnSpanning
	//<
	width:"*",							

    //>	@attr	formItem.height		(number : 20 : IRW)
	// Default height of this item.
	// @group formLayout
    // @visibility external
    // @example formLayoutFilling
	//<
    
	height:20,

    //>	@attr formItem.colSpan		(number : 1 : IRW)
	// Number of columns that this item spans (not including label)
	// @group formLayout
    // @visibility external
	//<	
	colSpan:1,

    //>	@attr formItem.rowSpan		(number : 1 : IRW)