formitem.js

javascript 很酷的类库

        
        //> @attr   formItemIcon.showFocusedWithIcon (boolean : null : IRWA)
        // If this icon will be updated to show focus (see +link{formItemIcon.showFocused}, 
        // +link{formItem.showFocusedIcons}), this property governs whether the focused state should
        // be shown when the item as a whole recieves focus or just if the icon recieves focus.
        // If this property is unset, default behavior is to show focused state when the item
        // recieves focus. 
        // @see formItem.showFocusedIcons
        // @see formItemIcon.showFocused
        // @group  formIcons
        // @visibility external
        //<
        
        //> @attr   formItemIcon.neverDisable (boolean : null : IRWA)
        //  If <code>icon.neverDisable</code> is true, when this form item is disabled, the 
        //  icon will remain enabled. 
        //  Note that disabling the entire form will disable all items, together with their 
        //  icons including those marked as neverDisable - this property only has an effect 
        //  if the form is enabled and a specific item is disabled within it.
        //  @group  formIcons
        //  @visibility external
        //<
    
        //> @method formItemIcon.click()
        //      StringMethod action to fire when this icon is clicked
        //      If unset the form item's <code>iconClick</code> method will be fired instead (if
        //      specified).
        //  @param  form (DynamicForm)  The Dynamic Form to which this icon's item belongs.
        //  @param  item (FormItem)     The Form Item containing this icon
        //  @param  icon (FormItemIcon) A pointer to the form item icon clicked
        //  @group  formIcons
        //  @visibility external
        //  @example formIcons
        //<    

        //> @method formItemIcon.keyPress()
        //      StringMethod action to fire when this icon has focus and recieves a keypress
        //      event.
        //      If unset the form item's <code>iconKeyPress</code> method will be fired instead 
        //      (if specified).
        //  @param  keyName (string)    Name of the key pressed
        //  @param  character (character) character produced by the keypress
        //  @param  form (DynamicForm)  The Dynamic Form to which this icon's item belongs.
        //  @param  item (FormItem)     The Form Item containing this icon
        //  @param  icon (FormItemIcon) A pointer to the form item icon 
        //  @group  formIcons
        //  @visibility external
        //<
                
        //> @attr   formItemIcon.width (number : null : IRW)
        //      If set, this property determines the width of this icon in px.
        //      If unset the form item's <code>iconWidth</code> property will be used instead.
        //  @group  formIcons
        //  @visibility external
        //  @see    attr:formItem.iconWidth
        //<
        
        //> @attr   formItemIcon.height (number : null : IRW)
        //      If set, this property determines the height of this icon in px.
        //      If unset the form item's <code>iconHeight</code> property will be used instead.
        //  @group  formIcons
        //  @visibility external
        //  @see    attr:formItem.iconHeight
        //<    
        
        //> @attr   formItemIcon.hspace (number : null : IRWA)
        //      If set, this property determines the number of pixels space to be displayed on 
        //      the left of this form item icon.<br>
        //      If unset the form item's <code>iconHSpace</code> property will be used instead.
        //  @group  formIcons
        //  @visibility internal
        //  @see    attr:formItem.iconHSpace
        //<
    
        //> @attr   formItemIcon.prompt (string : null : IRWA)
        //      If set, this property will be displayed as a prompt (and tooltip text) for this form
        //      item icon.
        //      If unset the form item's <code>iconPrompt</code> property will be used instead.
        //  @group  formIcons
        //  @visibility internal
        //  @see    attr:formItem.iconPrompt
        //<

    // Hints
	// --------------------------------------------------------------------------------------------

    //>	@attr	formItem.hint		(string : null : IRWA)
	// Specifies "hint" string to show next to the form item to indicate something to the user.
    // This string generally appears to the right of the form item.
    // 
    // @see hintStyle
	// @group appearance
    // @visibility external
    // @example formHints
	//<

    //>	@attr	formItem.showHint		(boolean : true : IRWA)
	// If a hint is defined for this form item, should it be shown?
    //
	// @group appearance
    // @visibility external
	//<
	showHint:true,
    
    // Styles
	// --------------------------------------------------------------------------------------------
    
    //>	@attr	formItem.showFocused     (boolean : false : IRWA)
	// When this item recieves focus, should it be re-styled to indicate it has focus?
    //
	// @group appearance
    // @visibility external
    // @see formItem.cellStyle
    //<
	showFocused:false,
    
    //>	@attr	formItem.showDisabled     (boolean : true : IRWA)
	// When this item is disabled, should it be re-styled to indicate its disabled state?
    //
	// @group appearance
    // @visibility external
    // @see cellStyle
    //<
	showDisabled:true,
    
    // Discussion on compound item / skinning for jsdoc. This is referred to by other JSDoc 
    // entries but doesn't need to show up in the doc-tree.
    //> @groupDef CompoundFormItem_skinning
    // When skinning basic FormItems like SelectItem and TextItem, consider that compound form
    // items like DateItem and ComboBox reuse simpler items like SelectItem and TextItem, so adding
    // a border to SelectItem would also apply a border to each select item within DateItem.<br>
    // To avoid such side-effects, if you want to add styling to all SelectItems used in your 
    // application, you can create an application-specific subclass like MySelectItem and apply 
    // properties there.<br>
    // @visibility external
    //<
    
    //> @type FormItemBaseStyle
    // This string is the base css class name applied to a FormItem (or some part of a form item).
    // The style name will be modified as the 'state' of the form item changes. Specifically:<ul>
    // <li>If +link{FormItem.showFocused} is true, when the form item recieves focus, this
    //     style will be have the suffix <code>"Focused"</code> appended to it.</li>
    // <li>If +link{FormItem.showErrorStyle} is true, if the form item has errors, this
    //     style will be have the suffix <code>"Error"</code> appended to it.</li>
    // <li>If +link{FormItem.showDisabled} is true, when the form item is disabled, this
    //     style will be have the suffix <code>"Disabled"</code> appended to it.</li></ul>
    // So for example if the <code>cellStyle</code> for some form item is set to <code>"formCell"</code>
    // and <code>FormItem.showFocused</code> is true, when the form item recieves focus, the
    // form item's cell will have the <code>"formCellDisabled"</code> style applied to it.
    // @visibility external
    // @group appearance
    //<
    
    //> @attr formItem.cellStyle  (FormItemBaseStyle : "formCell" : IRW)
    // CSS style applied to the form item as a whole, including the text element, any icons, and
    // any hint text for the item. Applied to the cell containing the form item.
    // <P>
    // NOTE: See the +link{group:CompoundFormItem_skinning} discussion for special skinning considerations.
    // @visibility external
    // @group appearance
    //<
    cellStyle:"formCell",
    
    //>	@attr formItem.hintStyle      (string : "formHint" : IRW)
	// CSS class for the "hint" string.
    //
    // @see hint
	// @group appearance
    // @visibility external
	//<
    
    hintStyle:"formHint",
    
    //> @attr formItem.titleStyle (FormItemBaseStyle : "formTitle" : IRW)
    // Base CSS class name for a form item's title.
    // @group title
    // @visibility external
    // @see formItem.cellStyle
    //<
    titleStyle:"formTitle",

    //> @attr formItem.textBoxStyle (FormItemBaseStyle : null : IRW)
    // Base CSS class name for a form item's text box element.
    // <P>
    // NOTE: See the +link{group:CompoundFormItem_skinning} discussion for special skinning considerations.
    // @group appearance
    // @visibility external
    // @see formItem.cellStyle
    //<
    //textBoxStyle:null,
    
    //> @attr formItem.pickerIconStyle (FormItemBaseStyle : null : IRW)
    // Base CSS class name for a form item's picker icon cell. If unset inherits from 
    // this items <code>controlStyle</code>.
    // @visibility pickerIcon
    // @see formItem.controlStyle
    // @group appearance
    // @see formItem.cellStyle
    //<
    //pickerIconStyle:null,
    
    //> @attr formItem.controlStyle (FormItemBaseStyle : null : IRW)
    // Base CSS class name for a form item's control box (surrounds text box and picker).
    // <P>
    // NOTE: See the +link{group:CompoundFormItem_skinning} discussion for special skinning considerations.
    // @group appearance
    // @visibility pickerIcon
    // @see formItem.cellStyle
    //<
    //controlStyle:null,
    
    // -------------------------------
    // Deprecated styling properties:
    
    //>	@attr formItem.cellClassName		(CSSStyleName : "formCell" : IRW)
	// CSS class for a form item's cell in the form layout
    // 
	// @group appearance
    // @visibility external
    // @deprecated As of SmartClient version 5.5, deprecated in favor of +link{formItem.cellStyle}
	//<

    //>	@attr formItem.errorCellClassName		(CSSStyleName : "formError" : IRW)
    // CSS class for a form item's cell when a validation error is showing.
    //
	// @group appearance
    // @visibility external
    // @deprecated As of SmartClient version 5.5 deprecated in favor of +link{formItem.cellStyle}
	//<

	//>	@attr	formItem.titleClassName (CSSStyleName : "formTitle" : IRW)
    // CSS class for the form item's title.
    // @group title
    // @visibility external
    // @deprecated As of SmartClient Version 5.5, use +link{formItem.titleStyle} instead
    //<
	//titleClassName : "formTitle",

	//>	@attr	formItem.titleErrorClassName (CSSStyleName : "formTitleError" : IRW)
    // CSS class for a form item's title when a validation error is showing.
    // @group title
    // @visibility external
    // @deprecated As of SmartClient Version 5.5, use +link{formItem.titleStyle} instead    
    //<
	//titleErrorClassName : "formTitleError",
    
    //>	@attr	formItem.hintClassName		(CSSStyleName : "formHint" : IRW)
	// CSS class for the "hint" string.
    //
    // @see hint
	// @group appearance
    // @visibility external
    // @deprecated As of SmartClient version 5.5, deprecated in favor of +link{FormItem.hintStyle}
	//<

    //> @attr   formItem._hasDataElement    (boolean : false : IRW)
    //      Internal flag designating whether this element type has a data element 
    //      (an actual form element, holding a value).
    //      Accessed via the 'hasDataElement()' method.
    // @group formValues
    // @visibility   internal
    // @see     method:FormItem.hasDataElement
    // @see     method:FormItem.getDataElement
    //<
    _hasDataElement:false
    
    // Hovers
    // -----------------------------------------------------------------------------------------
    //> @attr formItem.hoverDelay (number : null : IRWA)
    // If specified, this is the number of miliseconds to wait between the user rolling over 
    // this form item, and triggering any hover action for it.<br>
    // If not specified <code>this.form.itemHoverDelay</code> will be used instead.
    // @group Hovers
    // @visibility external
    //<
    //,hoverDelay:null
        
    //> @attr formItem.hoverWidth (measure : null : [IRW])
    // Option to specify a width for any hover shown for this item.
    // @see DynamicForm.itemHoverWidth
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverHeight  (measure : null : [IRW])
    // Option to specify a height for any hover shown for this item.
    // @see DynamicForm.itemHoverHeight
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverAlign (Alignment  : null : [IRW])
    // Text alignment  for text displayed in this item's hover canvas, if shown.
    // @see DynamicForm.itemHoverAlign
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverVAlign (measure : null : [IRW])
    // Vertical text alignment  for text displayed in this item's hover canvas, if shown.
    // @see DynamicForm.itemHoverVAlign
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverStyle (CSSStyleName  : null : [IRW])
    // Explict CSS Style for any hover shown for this item.
    // @see DynamicForm.itemHoverStyle
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverOpacity (number : null : [IRW])
    // Opacity for any hover shown for this item
    // @see DynamicForm.itemHoverOpacity
    // @group Hovers
    // @visibility external
    //<
    
    //> @attr FormItem.hoverRect (object : null : [IRWA])
    // Explicit placement information for any hover shown for this item.
    // Should be spe