public class

PaperSizes

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.PaperSizes

Class Overview

Defines a single valid paper size. The application presents this paper size to the user when the print functionality is used.

Summary

Constants
String ATT_CUSTOM_DESC_ID
String ATT_DESC
String ATT_DESC_ID
String ATT_DESKTOP_KEY
String ATT_KEY
String NODE_PAPER_SIZE
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
PaperSizes()
Default no-arg constructor.
PaperSizes(Node root)
Class constructor.
Public Methods
String getCustomDescriptorID()
This method is deprecated. The CustomDescriptorID is not used by the application and will be removed in future versions.
String getDescription()
Returns the descriptor that the application should use to display the paper size if the desc-id attribute is missing.
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.
String getDesktopKey()
Returns the desktop-key, a unique identifier used by MicroStrategy Desktop to identify the paper size.
String getMessage(Messages messages)
void setCustomDescriptorID(String customDescriptorID)
This method is deprecated. The CustomDescriptorID is not used by the application and will be removed in future versions.
void setDescription(String description)
Sets the descriptor that the application should use to display the paper size if the desc-id attribute is missing.
void setDescriptorID(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.
void setDesktopKey(String desktopKey)
Set the desktop key, a unique identifier used by MicroStrategy Desktop to identify the paper size.
void setKey(String key)
Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the paper size.
Protected Methods
String getKeyAttribute()
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.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String ATT_CUSTOM_DESC_ID

Constant Value: "custom_desc_id"

public static final String ATT_DESC

Constant Value: "desc"

public static final String ATT_DESC_ID

Constant Value: "desc_id"

public static final String ATT_DESKTOP_KEY

Constant Value: "desktop-key"

public static final String ATT_KEY

Constant Value: "key"

public static final String NODE_PAPER_SIZE

Constant Value: "paper-size"

Public Constructors

public PaperSizes ()

Default no-arg constructor.

public PaperSizes (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.

Public Methods

public String getCustomDescriptorID ()

This method is 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

public String getDescription ()

Returns the descriptor that the application should use to display the paper size if the desc-id attribute is missing.

public 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.

public String getDesktopKey ()

Returns the desktop-key, a unique identifier used by MicroStrategy Desktop to identify the paper size.

public 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.

public void setCustomDescriptorID (String customDescriptorID)

This method is 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

public void setDescription (String description)

Sets the descriptor that the application should use to display the paper size if the desc-id attribute is missing.

public void setDescriptorID (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.

public void setDesktopKey (String desktopKey)

Set the desktop key, a unique identifier used by MicroStrategy Desktop to identify the paper size.

public void setKey (String key)

Sets the key for this paper size, a unique identifier used by MicroStrategy Web to identify the paper size.

Protected Methods

protected String getKeyAttribute ()

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.