Class GuiElementsBlockTransform

    • Constructor Detail

      • GuiElementsBlockTransform

        public GuiElementsBlockTransform()
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.
      • isFeatureAvailable

        public boolean isFeatureAvailable​(java.lang.String feature)
        Description copied from class: AbstractAppTransform
        Convenience method. Maps the isFeatureAvailable method of the Bean currently bean Transformed.
        Overrides:
        isFeatureAvailable in class AbstractAppTransform
        Parameters:
        feature - the feature Id.
        Returns:
        true by default, or whatever _bean.isFeatureAvailable(feature) returns;
      • getPicker

        protected ShortcutList getPicker​(java.lang.String pickerName)
        Return a specific Picker's ShortcutList.
        Parameters:
        pickerName - The name of the picker to retrieve.
        Returns:
        A ShortcutList that contains the picker elements.
      • removeListItems

        public void removeListItems​(BlockList list,
                                    java.lang.String indexString)
        Removes items from a BlockList.
        Parameters:
        list - The BlockList to be edited.
        indexString - A comma delimited string of indexes to be removed from the list.
      • getPickerList

        public java.util.ArrayList<Shortcut> getPickerList​(java.lang.String name)
        Return the requested picker list. This method will verify each Shortcut using it's feature id's if present in the picker.
        Parameters:
        name - The name of the desired picker from the pageConfig.xml file.
        Returns:
        An ArrayList populated with the Shortcut elements for this picker.
      • getListAttribute

        public java.lang.String getListAttribute​(Shortcut shortcut,
                                                 java.lang.String name)
        Extracts an attribute node from a Shortcut element.
        Parameters:
        shortcut - The current Shortcut from a picker list.
        name - The name of the requested attribute.
        Returns:
        A String containing the requested attribute value.
      • getShortcutDescriptor

        public java.lang.String getShortcutDescriptor​(Shortcut shortcut)
        Extracts the descriptors from a Shortcut element.
        Parameters:
        shortcut - The current Shortcut from a picker list.
        Returns:
        A String containing the requested descriptor value.
      • getAutoStyles

        public java.util.ArrayList<java.util.List<java.lang.String>> getAutoStyles()
        Return the list of available autostyles.
        Returns:
        An ArrayList populated with lists of elements for this picker, each list has in 0 the id and in 1 the name.
      • getElementID

        public java.lang.String getElementID​(java.util.List<java.lang.String> obj)
        Extracts the ID from a Shortcut element.
        Parameters:
        obj - shortcut The current Shortcut from a picker list.
        Returns:
        A String containing the requested descriptor value.
      • getElementName

        public java.lang.String getElementName​(java.util.List<java.lang.String> obj)
        Extracts the ID from a Shortcut element.
        Parameters:
        obj - shortcut The current Shortcut from a picker list.
        Returns:
        A String containing the requested descriptor value.
      • getRequestKeyValue

        protected java.lang.String getRequestKeyValue​(java.lang.String keyName)
        Returns the value of a RequestKey using the getRequestKeys method then getValue.
        Parameters:
        keyName - The name of the RequestKey to return.
        Returns:
        The String value of the specified RequestKey.
      • getRequestParameterValue

        public java.lang.String getRequestParameterValue​(java.lang.String name,
                                                         java.lang.String defaultValue)
        Parameters:
        name -
        defaultValue -
        Returns:
        the value of a parameter using the getRequestKeyValue or the default string if null
      • getRequestParameterValueEncoded

        public java.lang.String getRequestParameterValueEncoded​(java.lang.String name,
                                                                java.lang.String defaultValue)
        Parameters:
        name -
        defaultValue -
        Returns:
        encode value of a parameter return by getRequestParameterValue