Class PaperSizes

    • Constructor Detail

      • PaperSizes

        public PaperSizes()
        Default no-arg constructor.
      • PaperSizes

        public PaperSizes​(org.w3c.dom.Node root)
        Class constructor. Initializes a PaperSizes instance based on the information included on the XML Node
        Parameters:
        root - Node instance representing the paper size information.
    • Method Detail

      • getKeyAttribute

        protected java.lang.String getKeyAttribute()
        Description copied from class: AbstractConfigurationElement
        This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
        Specified by:
        getKeyAttribute in class AbstractConfigurationElement
        Since:
        MicroStrategy Web 9.0.0
      • getMessage

        public java.lang.String getMessage​(Messages messages)
        Parameters:
        messages - the messages l10n object.
        Returns:
        the paper size's localized descriptor, or the description if the descriptionId is empty.
      • setKey

        public void setKey​(java.lang.String key)
        Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the paper size.
      • getDesktopKey

        public java.lang.String getDesktopKey()
        Returns the desktop-key, a unique identifier used by MicroStrategy Desktop to identify the paper size.
      • setDesktopKey

        public void setDesktopKey​(java.lang.String desktopKey)
        Set the desktop key, a unique identifier used by MicroStrategy Desktop to identify the paper size.
      • getDescriptorID

        public java.lang.String getDescriptorID()
        Returns the descriptor id, that is Resource Bundle item id that the application should use to display the paper size descriptor in the language of the user's locale.
      • setDescriptorID

        public void setDescriptorID​(java.lang.String descriptorID)
        Set the descriptor id, that is Resource Bundle item id that the application should use to display the paper size descriptor in the language of the user's locale.
      • getDescription

        public java.lang.String getDescription()
        Returns the descriptor that the application should use to display the paper size if the desc-id attribute is missing.
      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the descriptor that the application should use to display the paper size if the desc-id attribute is missing.
      • getCustomDescriptorID

        @Deprecated
        public java.lang.String getCustomDescriptorID()
        Deprecated.
        The CustomDescriptorID is not used by the application and will be removed in future versions.
        Returns:
        the custom descriptor ID for this paper size
      • setCustomDescriptorID

        @Deprecated
        public void setCustomDescriptorID​(java.lang.String customDescriptorID)
        Deprecated.
        The CustomDescriptorID is not used by the application and will be removed in future versions.
        Set the custom descriptor ID of this paper size to the given parameter