Class ItemFactory


  • public class ItemFactory
    extends Object
    Collection of useful factory methods for form items.
    Since:
    6.0
    Author:
    Marco Meschieri - LogicalDOC
    • Constructor Detail

      • ItemFactory

        public ItemFactory()
    • Method Detail

      • newColorItemPicker

        public static com.smartgwt.client.widgets.form.fields.ColorPickerItem newColorItemPicker​(String name,
                                                                                                 String title,
                                                                                                 String value,
                                                                                                 boolean clearOption,
                                                                                                 com.smartgwt.client.widgets.form.fields.events.ChangedHandler changedHandler)
      • newDateItem

        public static com.smartgwt.client.widgets.form.fields.DateItem newDateItem​(String name,
                                                                                   String title)
        Creates a new DateItem.
        Parameters:
        name - The item name (mandatory)
        title - The item title (optional)
        Returns:
        the new item
      • newDateItemForAttribute

        public static com.smartgwt.client.widgets.form.fields.DateItem newDateItemForAttribute​(String name,
                                                                                               String title)
        Creates a new DateItem for the Extended AttributesDS.
        Parameters:
        name - The item name (mandatory)
        title - The item title
        Returns:
        the new item
      • newMiniDateRangeItem

        public static com.smartgwt.client.widgets.form.fields.MiniDateRangeItem newMiniDateRangeItem​(String name,
                                                                                                     String title)
      • newMultipleUsersSelector

        public static com.smartgwt.client.widgets.form.fields.MultiComboBoxItem newMultipleUsersSelector​(String name,
                                                                                                         String title,
                                                                                                         boolean skipDisabled,
                                                                                                         long[] selection)
      • newFolderSelectorForAttribute

        public static com.smartgwt.client.widgets.form.fields.TextItem newFolderSelectorForAttribute​(String name,
                                                                                                     String title,
                                                                                                     boolean allowsNull,
                                                                                                     List<com.smartgwt.client.widgets.form.fields.FormItemIcon> additionalIcons)
      • newUserSelectorForAttribute

        public static com.smartgwt.client.widgets.form.fields.SelectItem newUserSelectorForAttribute​(String name,
                                                                                                     String title,
                                                                                                     String groupIdOrName,
                                                                                                     List<com.smartgwt.client.widgets.form.fields.FormItemIcon> additionalIcons)
      • newRecipientTypeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newRecipientTypeSelector​(String name)
      • newUserTypeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newUserTypeSelector​(String name,
                                                                                             int userType)
      • newDashletTypeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDashletTypeSelector​(String value)
      • newDensitySelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDensitySelector()
      • newSkinSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newSkinSelector()
      • newDateOperator

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDateOperator​(String name,
                                                                                         String title)
      • newSizeOperator

        public static com.smartgwt.client.widgets.form.fields.SelectItem newSizeOperator​(String name,
                                                                                         String title)
      • newBarcodeGenerationFormatSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newBarcodeGenerationFormatSelector​(String name,
                                                                                                            String title,
                                                                                                            String value)
      • newLanguageSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newLanguageSelector​(String name,
                                                                                             boolean withEmpty,
                                                                                             boolean gui)
      • newCharsetSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newCharsetSelector​(String name)
      • newStorageSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newStorageSelector​(String name,
                                                                                            Integer value)
      • newStorageTypeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newStorageTypeSelector()
      • newComparatorSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newComparatorSelector()
      • newComparatorSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newComparatorSelector​(String inExt)
      • newFormatConverterSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newFormatConverterSelector()
      • newFormatConverterSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newFormatConverterSelector​(String inExt,
                                                                                                    String outExt)
      • newEmailItem

        public static com.smartgwt.client.widgets.form.fields.TextItem newEmailItem​(String name,
                                                                                    String title,
                                                                                    boolean multiple)
      • newEmailComboSelector

        public static com.smartgwt.client.widgets.form.fields.ComboBoxItem newEmailComboSelector​(String name,
                                                                                                 String title)
      • newEmailSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEmailSelector​(String name,
                                                                                          String title)
      • newEmailFromSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEmailFromSelector​(String name,
                                                                                              String title)
      • newGroupSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newGroupSelector​(String name,
                                                                                          String title)
      • newUserSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newUserSelector​(String name,
                                                                                         String title,
                                                                                         String groupIdOrName,
                                                                                         boolean required,
                                                                                         boolean skipDisabled)
      • newTenantSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newTenantSelector()
      • newAutomationRoutineSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newAutomationRoutineSelector​(String name,
                                                                                                      Long value,
                                                                                                      com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler,
                                                                                                      boolean showEmpty)
      • newRadioGroup

        public static com.smartgwt.client.widgets.form.fields.RadioGroupItem newRadioGroup​(String name,
                                                                                           String title)
      • newBooleanSelector

        public static com.smartgwt.client.widgets.form.fields.RadioGroupItem newBooleanSelector​(String name,
                                                                                                String title)
      • newCheckbox

        public static com.smartgwt.client.widgets.form.fields.CheckboxItem newCheckbox​(String name,
                                                                                       String title)
      • newMultiComboBoxItem

        public static com.smartgwt.client.widgets.form.fields.MultiComboBoxItem newMultiComboBoxItem​(String name,
                                                                                                     String title,
                                                                                                     com.smartgwt.client.data.DataSource options,
                                                                                                     Object[] values)
      • newTagsComboBoxItem

        public static com.smartgwt.client.widgets.form.fields.MultiComboBoxItem newTagsComboBoxItem​(String name,
                                                                                                    String title,
                                                                                                    TagsDS options,
                                                                                                    Object[] tags)
      • newBarcodeFormatsComboBoxItem

        public static com.smartgwt.client.widgets.form.fields.MultiComboBoxItem newBarcodeFormatsComboBoxItem​(String name,
                                                                                                              String title,
                                                                                                              String values)
      • newBarcodeFormatsComboBoxItem

        public static com.smartgwt.client.widgets.form.fields.MultiComboBoxItem newBarcodeFormatsComboBoxItem​(String name,
                                                                                                              String title,
                                                                                                              String[] values)
      • newTagsMultiplePickList

        public static com.smartgwt.client.widgets.form.fields.SelectItem newTagsMultiplePickList​(String name,
                                                                                                 String title,
                                                                                                 TagsDS options,
                                                                                                 Object[] tags)
      • newMultipleSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newMultipleSelector​(String name,
                                                                                             String title)
      • newPrioritySelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newPrioritySelector​(String name,
                                                                                             String title)
      • newWelcomeScreenSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newWelcomeScreenSelector​(Integer value)
      • newDashletSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDashletSelector​(String name,
                                                                                            String title)
      • newEventsSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEventsSelector​(String name,
                                                                                           String title,
                                                                                           com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler,
                                                                                           boolean folder,
                                                                                           boolean workflow,
                                                                                           boolean user)
      • newOCRStatusSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newOCRStatusSelector​(Integer value)
      • newEventSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEventSelector​(String name,
                                                                                          String title,
                                                                                          com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler,
                                                                                          boolean folder,
                                                                                          boolean workflow,
                                                                                          boolean user)
      • newSelectItem

        public static com.smartgwt.client.widgets.form.fields.SelectItem newSelectItem​(String name,
                                                                                       String title)
      • newConversionFormatItem

        public static com.smartgwt.client.widgets.form.fields.SelectItem newConversionFormatItem​(String fileName)
      • newComboBoxItem

        public static com.smartgwt.client.widgets.form.fields.ComboBoxItem newComboBoxItem​(String name,
                                                                                           String title)
      • newYesNoSelectItem

        public static com.smartgwt.client.widgets.form.fields.SelectItem newYesNoSelectItem​(String name,
                                                                                            String title)
      • newSpinnerItem

        public static com.smartgwt.client.widgets.form.fields.SpinnerItem newSpinnerItem​(String name,
                                                                                         String title,
                                                                                         Long value)
      • newSpinnerItem

        public static com.smartgwt.client.widgets.form.fields.SpinnerItem newSpinnerItem​(String name,
                                                                                         String title,
                                                                                         Integer value)
      • newImgIcon

        public static com.smartgwt.client.widgets.Img newImgIcon​(String name)
      • newImg

        public static com.smartgwt.client.widgets.Img newImg​(String name)
      • newBrandImg

        public static com.smartgwt.client.widgets.Img newBrandImg​(String name,
                                                                  GUIInfo info)
      • newItemIcon

        public static com.smartgwt.client.widgets.form.fields.FormItemIcon newItemIcon​(String image)
      • newHeaderIcon

        public static com.smartgwt.client.widgets.HeaderControl.HeaderIcon newHeaderIcon​(String image)
      • newTextItem

        public static com.smartgwt.client.widgets.form.fields.TextItem newTextItem​(String name,
                                                                                   String title,
                                                                                   String value)
        Creates a new TextItem.
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the text item
      • newTextItemForAutomation

        public static com.smartgwt.client.widgets.form.fields.TextItem newTextItemForAutomation​(String name,
                                                                                                String title,
                                                                                                String value,
                                                                                                com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler)
      • newRichTextItemForAutomation

        public static com.smartgwt.client.widgets.form.fields.RichTextItem newRichTextItemForAutomation​(String name,
                                                                                                        String title,
                                                                                                        String value,
                                                                                                        com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler)
      • newRowSpacer

        public static com.smartgwt.client.widgets.form.fields.RowSpacerItem newRowSpacer()
      • newStringItemForAttribute

        public static com.smartgwt.client.widgets.form.fields.FormItem newStringItemForAttribute​(GUIAttribute att)
        Creates a new TextItem for an extended attribute
        Parameters:
        att - the attribute
        Returns:
        the new item
      • newPasswordItem

        public static com.smartgwt.client.widgets.form.fields.PasswordItem newPasswordItem​(String name,
                                                                                           String title,
                                                                                           String value)
      • newSimpleTextItem

        public static com.smartgwt.client.widgets.form.fields.TextItem newSimpleTextItem​(String name,
                                                                                         String title,
                                                                                         String value)
        Creates a new TextItem that validates a simple text
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newStaticTextItem

        public static com.smartgwt.client.widgets.form.fields.StaticTextItem newStaticTextItem​(String name,
                                                                                               String title,
                                                                                               String value)
        Creates a new StaticTextItem
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newLongItem

        public static com.smartgwt.client.widgets.form.fields.IntegerItem newLongItem​(String name,
                                                                                      String title,
                                                                                      Long value)
        Creates a new IntegerItem
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newIntegerItem

        public static com.smartgwt.client.widgets.form.fields.IntegerItem newIntegerItem​(String name,
                                                                                         String title,
                                                                                         Integer value)
        Creates a new IntegerItem.
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newIntegerItemForAttribute

        public static com.smartgwt.client.widgets.form.fields.FormItem newIntegerItemForAttribute​(String name,
                                                                                                  String label,
                                                                                                  Integer value)
        Creates a new IntegerItem for the Extended AttributesDS.
        Parameters:
        name - The item name (mandatory)
        label - The item label
        value - The item value (optional)
        Returns:
        the new item
      • newBooleanSelectorForAttribute

        public static com.smartgwt.client.widgets.form.fields.SelectItem newBooleanSelectorForAttribute​(String name,
                                                                                                        String title,
                                                                                                        boolean allowEmpty)
        Simple boolean selector for Extended Attribute
        Parameters:
        name - name of the item
        title - title of the item(optional)
        allowEmpty - flag to indicate id the item must accept empty value
        Returns:
        the new item
      • newValidateIntegerItem

        public static com.smartgwt.client.widgets.form.fields.IntegerItem newValidateIntegerItem​(String name,
                                                                                                 String title,
                                                                                                 Integer value,
                                                                                                 Integer min,
                                                                                                 Integer max)
        Creates a new IntegerItem with a range validator
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        min - The item minimum value (optional)
        max - The item maximum value (optional)
        Returns:
        the new item
      • newSpinnerItem

        public static com.smartgwt.client.widgets.form.fields.SpinnerItem newSpinnerItem​(String name,
                                                                                         String title,
                                                                                         Integer value,
                                                                                         Integer min,
                                                                                         Integer max)
        Creates a new SpinnerItem(with a range validator)
        Parameters:
        name - name of the item
        title - title of the item(optional)
        value - default value(optional)
        min - minimum value(optional)
        max - maximum value(optional)
        Returns:
        the new item
      • newLinkItem

        public static com.smartgwt.client.widgets.form.fields.LinkItem newLinkItem​(String name,
                                                                                   String title)
      • newTextAreaItem

        public static com.smartgwt.client.widgets.form.fields.TextAreaItem newTextAreaItem​(String name,
                                                                                           String title,
                                                                                           String value)
        Creates a new TextAreaItem
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newTextAreaItemForAutomation

        public static com.smartgwt.client.widgets.form.fields.TextAreaItem newTextAreaItemForAutomation​(String name,
                                                                                                        String title,
                                                                                                        String value,
                                                                                                        com.smartgwt.client.widgets.form.fields.events.ChangedHandler handler,
                                                                                                        boolean withHtmlEditor)
      • newDueTimeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDueTimeSelector​(String name,
                                                                                            String title)
      • newTimeItem

        public static com.smartgwt.client.widgets.form.fields.TimeItem newTimeItem​(String name,
                                                                                   String title)
      • newTemplateSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newTemplateSelector​(boolean withEmpty,
                                                                                             Long selectedTemplateId)
      • newOCRTemplateSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newOCRTemplateSelector​(boolean withEmpty,
                                                                                                Long filterTemplateId,
                                                                                                Long selectedTemplateId)
        Creates a select list with the OCR templates
        Parameters:
        withEmpty - id an empty row must be shown
        filterTemplateId - the document template id to filter the ocr templates
        selectedTemplateId - identifier of the template to be selected by default
        Returns:
        the item
      • newBarcodeTemplateSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newBarcodeTemplateSelector​(boolean withEmpty,
                                                                                                    Long filterTemplateId,
                                                                                                    Long selectedTemplateId)
        Creates a select list with the barcode templates
        Parameters:
        withEmpty - id an empty row must be shown
        filterTemplateId - the document template id to filter the ocr templates
        selectedTemplateId - identifier of the template to be selected by default
        Returns:
        the item
      • newAttributeSetSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newAttributeSetSelector()
      • newAttributesSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newAttributesSelector()
      • newFrequencySelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newFrequencySelector​(String name,
                                                                                              String title)
      • newCalendarEventStatusSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newCalendarEventStatusSelector​(String name,
                                                                                                        String title)
      • newEmailProtocolSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEmailProtocolSelector​(String name,
                                                                                                  String title)
      • newEmailFolderingSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEmailFolderingSelector​(String name,
                                                                                                   String title)
      • newEffectSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEffectSelector​(String name,
                                                                                           String title)
      • newEmailFields

        public static com.smartgwt.client.widgets.form.fields.SelectItem newEmailFields​(String name,
                                                                                        String title)
      • newAliasTypeSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newAliasTypeSelector()
      • newArchiveSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newArchiveSelector​(int mode,
                                                                                            Integer status)
      • newImportCustomIds

        public static com.smartgwt.client.widgets.form.fields.SelectItem newImportCustomIds()
      • newWorkflowSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newWorkflowSelector()
      • newFormSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newFormSelector()
      • newStampSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newStampSelector()
      • newLinkLabel

        public static com.smartgwt.client.widgets.Label newLinkLabel​(String title)
      • newFloatItem

        public static com.smartgwt.client.widgets.form.fields.FloatItem newFloatItem​(String name,
                                                                                     String title,
                                                                                     Float value)
        Creates a new FloatItem.
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the new item
      • newFloatItemForAttribute

        public static com.smartgwt.client.widgets.form.fields.FormItem newFloatItemForAttribute​(String name,
                                                                                                String label,
                                                                                                Float value)
        Creates a new FloatItem for the Extended AttributesDS.
        Parameters:
        name - The item name (mandatory)
        label - The item label (optional)
        value - The item value (optional)
        Returns:
        the new item
      • newYesNoRadioItem

        public static com.smartgwt.client.widgets.form.fields.RadioGroupItem newYesNoRadioItem​(String name,
                                                                                               String label)
        Simple yes/no radio button. yes=true, no=false
        Parameters:
        name - name of the item
        label - label of the item(optional)
        Returns:
        the new item
      • newTagInputMode

        public static com.smartgwt.client.widgets.form.fields.SelectItem newTagInputMode​(String name,
                                                                                         String title)
      • newRunlevelSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newRunlevelSelector()
      • newFolderTemplateSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newFolderTemplateSelector()
      • newWorkspaceSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newWorkspaceSelector​(Long value)
      • newRetentionDateOption

        public static com.smartgwt.client.widgets.form.fields.SelectItem newRetentionDateOption​(int value)
      • newImportFolderProviderOption

        public static com.smartgwt.client.widgets.form.fields.SelectItem newImportFolderProviderOption​(String value)
      • newDocuSignTabType

        public static com.smartgwt.client.widgets.form.fields.SelectItem newDocuSignTabType​(String value)
      • newRetentionAction

        public static com.smartgwt.client.widgets.form.fields.SelectItem newRetentionAction​(int value)
      • new2AFMethodSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem new2AFMethodSelector​(String name,
                                                                                              String value)
      • newSplittingPolicySelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newSplittingPolicySelector()
      • newSplitSeparatorHandlingSelector

        public static com.smartgwt.client.widgets.form.fields.SelectItem newSplitSeparatorHandlingSelector()
      • newRichTextItemForNote

        public static com.smartgwt.client.widgets.form.fields.RichTextItem newRichTextItemForNote​(String name,
                                                                                                  String title,
                                                                                                  String value)
        Creates a new RichTextItem suitable for notes.
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        Returns:
        the text item
      • newRichTextItemForEmail

        public static com.smartgwt.client.widgets.form.fields.RichTextItem newRichTextItemForEmail​(String name,
                                                                                                   String title,
                                                                                                   String value,
                                                                                                   com.smartgwt.client.widgets.form.fields.events.ChangedHandler chagnedHandler)
        Creates a new RichTextItem suitable for emails.
        Parameters:
        name - The item name (mandatory)
        title - The item title (mandatory)
        value - The item value (optional)
        chagnedHandler - A handler thas is notified about changes (optional)
        Returns:
        the text item
      • filterItemName

        public static String filterItemName​(String name)
        Filter the name from problematic chars
        Parameters:
        name - name of the item
        Returns:
        sanitized name
      • originalItemName

        public static String originalItemName​(String name)
        Obtain the original item name
        Parameters:
        name - sanitized name
        Returns:
        original name