Package com.microstrategy.web.app
Class PaperSizes
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.app.PaperSizes
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
public class PaperSizes extends AbstractConfigurationElement
Defines a single valid paper size. The application presents this paper size to the user when the print functionality is used.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
AbstractConfigurationElement.FilteredList
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATT_CUSTOM_DESC_ID
static java.lang.String
ATT_DESC
static java.lang.String
ATT_DESC_ID
static java.lang.String
ATT_DESKTOP_KEY
static java.lang.String
ATT_KEY
static java.lang.String
NODE_PAPER_SIZE
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Constructor Summary
Constructors Constructor Description PaperSizes()
Default no-arg constructor.PaperSizes(org.w3c.dom.Node root)
Class constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCustomDescriptorID()
Deprecated.The CustomDescriptorID is not used by the application and will be removed in future versions.java.lang.String
getDescription()
Returns the descriptor that the application should use to display the paper size if the desc-id attribute is missing.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.java.lang.String
getDesktopKey()
Returns the desktop-key, a unique identifier used by MicroStrategy Desktop to identify the paper size.protected java.lang.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 thegetKey
andsetKey
methods.java.lang.String
getMessage(Messages messages)
void
setCustomDescriptorID(java.lang.String customDescriptorID)
Deprecated.The CustomDescriptorID is not used by the application and will be removed in future versions.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.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.void
setDesktopKey(java.lang.String desktopKey)
Set the desktop key, a unique identifier used by MicroStrategy Desktop to identify the paper size.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.-
Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation
-
-
-
-
Field Detail
-
NODE_PAPER_SIZE
public static final java.lang.String NODE_PAPER_SIZE
- See Also:
- Constant Field Values
-
ATT_KEY
public static final java.lang.String ATT_KEY
- See Also:
- Constant Field Values
-
ATT_DESKTOP_KEY
public static final java.lang.String ATT_DESKTOP_KEY
- See Also:
- Constant Field Values
-
ATT_DESC
public static final java.lang.String ATT_DESC
- See Also:
- Constant Field Values
-
ATT_DESC_ID
public static final java.lang.String ATT_DESC_ID
- See Also:
- Constant Field Values
-
ATT_CUSTOM_DESC_ID
public static final java.lang.String ATT_CUSTOM_DESC_ID
- See Also:
- Constant Field Values
-
-
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
- 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
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
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
-
-