formitem.js

javascript 很酷的类库

	// Number of rows that this item spans
	// @group formLayout
    // @visibility external
	//<
	rowSpan:1,

	//>	@attr formItem.startRow		(boolean : false : IRW)
	// Whether this item should always start a new row in the form layout.
	// @group formLayout
    // @visibility external
	//<
	
	//>	@attr formItem.endRow		(boolean : false : IRW)
	// Whether this item should end the row it's in in the form layout
	// @group formLayout
    // @visibility external
	//<
    
    // The align property is used by the dynamic form to align the item as a whole (control table
    // and all) in its cell.
    // In addition to this we support textAlign to align the contents within the text-box
    
	//>	@attr formItem.align		(Alignment : isc.Canvas.LEFT : IRW)
	// Alignment of this item in its cell
	//		@group	appearance
    // @visibility external
	//<

    //> @attr   formItem.textAlign  (Alignment : isc.Canvas.LEFT : IRW)
    // Alignment of the text / content within this form item
    // @group appearance
    // @visibility external
    //<

	//>	@attr	formItem.left       (integer : 0 : IRWA)
    // Left coordinate of this item in pixels.  Applies only when the containing DynamicForm
    // sets <code>itemLayout:"absolute"</code>.
    // @visibility absForm
	//<

	//>	@attr	formItem.top        (integer : 0 : IRWA)
    // Top coordinate of this item in pixels.  Applies only when the containing DynamicForm
    // sets <code>itemLayout:"absolute"</code>.
    // @visibility absForm
	//<
    
    //>	@attr	formItem.wrap       (boolean : null : IRW)
	// If true, item contents can wrap. If false, all the contents should appear on a single line.
    // @visibility internal
	//<
    
    //>	@attr	formItem.clipValue  (boolean : null : IRW)
    // If true, text that exceeds the specified size of the form item will be clipped    
    // @visibility internal
	//<
    
    

    // AutoComplete
	// --------------------------------------------------------------------------------------------
    //>	@attr	formItem.autoComplete   (AutoComplete : null : IRW)
    // Whether to do inline autoComplete.
    // <p>
    // If unset, defaults to form.autoComplete
    //
    // @see dynamicForm.autoComplete
    // @visibility autoComplete
    //<

    //>	@attr	formItem.uniqueMatch    (boolean : null : IRW)
    // When autoComplete is enabled, whether to offer only unique matches to the user.
    // <p>
    // If unset, defaults to form.uniqueMatch.
    //
    // @see dynamicForm.uniqueMatch
    // @visibility autoComplete
    //<

    //>	@attr	formItem.autoCompleteCandidates (Array : null : IRW)
    // Optional set of candidate completions.
    // <p>
    // If candidates are not specified, the values in the valueMap, if any, will be used, or
    // within a DataBound form, the other values currently present in the loaded portion of the
    // dataset.
    // @visibility autoComplete
    //<

    
    //>@attr    formItem.browserSpellCheck  (boolean : null : IRWA)
    // If this browser supports spell-checking of text editing elements, do we want this
    // enabled for this item? If unset the property will be inherited from the containing form
    // @visibility internal
    //<
    
    //browserSpellCheck:null
    
    // Icons
	// --------------------------------------------------------------------------------------------
    
    //>@attr    formItem.icons      (Array of FormItemIcon Properties : null  : IRW)
    //  An array of descriptor objects for icons to display in a line after this form item.
    //  These icons are clickable images, often used to display some kind of helper for 
    //  populating a form item.
    //  @group formIcons
    //  @see    class:FormItemIcon
    //  @visibility external
    //  @example formIcons
    //<

    //> @attr   formItem.defaultIconSrc      (SCImgURL : "[SKIN]/DynamicForm/default_formItem_icon.gif" : IRWA)
    // Default icon image source.     
    // Specify as the partial URL to an image, relative to the imgDir of this component.
    // To specify image source for a specific icon use the <code>icon.src</code> property.<br>
    // If this item is drawn in the disabled state, the url will be modified by adding 
    // "_Disabled" to get a disabled state image for the icon.
    // If <code>icon.showOver</code> is true, this url will be modified by adding "_Over" to get
    // an over state image for the icon.
    //  @group  formIcons
    //  @visibility external    
    //<
    defaultIconSrc:"[SKIN]/DynamicForm/default_formItem_icon.gif",

    //> @attr   formItem.showOverIcons  (boolean : null : IRWA)
    //  If we're showing icons, should we change their image source to the appropriate <i>over</i>
    //  source when the user rolls over (or puts focus onto) them?  Can be overridden on a per
    //  icon basis by the formItemIcon <code>showOver</code> property.
    //  @group formIcons
    //  @visibility external
    //<
    
    //> @attr   formItem.showFocusedIcons (boolean : null : IRWA)
    //  If we're showing icons, should we change their image source to the appropriate
    //  <i>focused</i>  source when this item has focus?  Can be overridden on a per
    //  icon basis by the formItemIcon <code>showFocused</code> property.
    //  @group formIcons
    //  @visibility external
    //<

    //> @attr   formItem.iconHSpace (number : 3 : IRWA)
    //      Horizontal space (in px) to leave between form item icons
    //  @group  formIcons
    //  @visibility internal
    //<
    iconHSpace:3,         
                                   
    //> @attr   formItem.iconVAlign (VerticalAlignment: "bottom" : [IRWA])
    //      How should icons be aligned vertically for this form item.
    //  @group  formIcons
    //  @visibility external
    //<
    // Options are "top", "center", "bottom" - Implemented via the css 'vertical-alignment'
    // property
    iconVAlign:isc.Canvas.BOTTOM,
      
    //> @attr   formItem.iconHeight (number : 20 : IRWA)
    //      Default height for form item icons
    //  @group  formIcons
    //  @visibility external    
    //<
    iconHeight:20,

    //> @attr   formItem.iconWidth (number : 20 : IRWA)
    //      Default width for form item icons
    //  @visibility external    
    //  @group  formIcons
    //<
    iconWidth:20,

    //> @attr formItem.prompt (string : null : IRW)
    //
    // This text is shown as a tooltip prompt when the cursor hovers over this item.
    //
    // @group basics
    // @visibility external
    //<
    
    // FormItem.implementsPromptNatively:
    // By default we show prompts in an ISC hover. However for some form items we'll write
    // out HTML that will cause a native hover prompt to show up instead. In these cases
    // we suppress the ISC hover
    
    //implementsPromptNatively:false,

    //> @attr   formItem.iconPrompt (string : "" : IRWA)
    //      Default prompt (and tooltip-text) for icons
    //  @group  formIcons
    //<
    
    iconPrompt:"",

    //> @attr   formItem.showIcons (boolean : true : IRWA)
    // Set to false to suppress writing out any +link{formItem.icons} for this item.
    //  @group  formIcons
    //  @visibility external
    //<
    
    showIcons:true,
    
    

    //> @attr   formItem.redrawOnShowIcon (boolean : true : IRWA)
    //      When dynamically showing/hiding icons for this form  item, should we force a
    //      redraw of the entire form?
    //  @group  formIcons
    //<
    
    redrawOnShowIcon:true,
    
    //> @attr   formItem.canTabToIcons  (boolean : null : IRWA)
    //      If set, this property determines if this form item's icons should be included in 
    //      the page's tab order, with the same tabIndex as this form item?<br>
    //      Note that if this form item has tabIndex -1, neither the form item nor the icons
    //      will be included in the page's tab order.
    //  @group  formIcons
    //  @visibility advancedIcons
    //<
    //canTabToIcons:null,
    
    // Validation Error Icon
    // We write out a special icon to indicate validation errors. This will not be part of the
    // icons array but will be rendered using some of the same code.

    //> @attr   formItem.errorIconHeight    (number : 16 : IRW)
    // Height of the error icon, if we're showing icons when validation errors occur.
    //  @group  errorIcon
    //  @visibility internal
    //<
    errorIconHeight: 16,
    //> @attr   formItem.errorIconWidth    (number : 16 : IRW)
    // Height of the error icon, if we're showing icons when validation errors occur.
    //  @group  errorIcon
    //  @visibility internal
    //<    
    errorIconWidth: 16,
    
    //> @attr   formItem.errorIconSrc    (SCImgURL : "[SKIN]/DynamicForm/validation_error_icon.png" : IRW)
    // URL of the image to show as an error icon, if we're showing icons when validation
    // errors occur.
    //  @group  errorIcon
    //  @visibility internal
    //<    
    errorIconSrc: "[SKIN]/DynamicForm/validation_error_icon.png",    
    
    //> @attr   formItem.showErrorIcon (boolean : null : IRW)
    // @include dynamicForm.showErrorIcons
    //  @group  errorIcon, validation, appearance
    //  @visibility external
    //<    
    // Note Actually writing this item (and the error text) into the DOM is handled by the
    // Form (or containerWidget) - but this property governs whether we include the icon in the
    // errorHTML we return.
    //showErrorIcon: null,
    
    //> @attr   formItem.showErrorText (boolean : null : IRW)
    // @include dynamicForm.showErrorIcons
    // @group  validation, appearance
    // @visibility external
    //<    
    //showErrorText: null,
    
    //>	@attr	formItem.showErrorStyle     (boolean : null : IRW)
    // @include dynamicForm.showErrorIcons
	// @group validation, appearance
    // @visibility external
    // @see FormItem.cellStyle
    //<    
	//showErrorStyle: null,
    
    //> @attr formItem.errorOrientation (align : null : IRW)
    // If +link{dynamicForm.showInlineErrors} is true, where should the error icon and text appear
    // relative to the form item itself. Valid options are <code>"top"</code>, 
    // <code>"bottom"</code>, <code>"left"</code> or <code>"right"</code>.<br>
    // If unset the orientation will be derived from +link{dynamicForm.errorOrientation}. 
    // @group validation, appearance
    // @visibility external
    //<
    //errorOrientation: null,

    // Define a jsdoc pseudo-class for form item icon descriptor objects.
    // ------

        //>	@object FormItemIcon
        //
        //  Form item icon descriptor objects used by Form Items to specify the appearance and
        //  behavior of icons displayed after the item in the page flow.
        //  
        //  @treeLocation   Client Reference/Forms/Form Items/FormItem
        //  @see attr:FormItem.icons
        //  @group formIcons
        //  @visibility external
        //  @example formIcons
        //<
    
        //> @attr   formItemIcon.src (string : null : IRW)
        //      If set, this property determines this icon's image source.
        //      If unset the form item's <code>defaultIconSrc</code> property will be used
        //      instead.<br>
        //      As with <code>defaultIconSrc</code> this URL will be modified by adding
        //      "_Over" or "_Disabled" if appropriate to show the icons over or disabled state.
        
        //  @group  formIcons
        //  @visibility external
        //  @see    attr:formItem.defaultIconSrc
        //  @example formIcons
        //<

                
        //> @attr   formItemIcon.showOver (boolean : null : IRWA)
        //  Should this icon's image switch to the appropriate "over" source when the user rolls
        //  over or focuses on the icon?   
        //  @group  formIcons
        //  @visibility external
        //  @see    attr:formItem.showOverIcons
        //<

        //> @attr   formItemIcon.showFocused (boolean : null : IRWA)
        // Should this icon's image switch to the appropriate "focused" source when the user puts
        // focus on the form item or icon? 
        // @see formItem.showFocusedIcons
        // @see formItemIcon.showFocusedWithItem
        //  @group  formIcons
        //  @visibility external
        //<