public class

PreferenceValidationForMargins

extends PreferenceDefinitionImpl
java.lang.Object
   ↳ com.microstrategy.web.preferences.PreferenceDefinitionBase
     ↳ com.microstrategy.web.preferences.PreferenceDefinitionImpl
       ↳ com.microstrategy.web.preferences.PreferenceValidationForMargins

Class Overview

This class validates Margin preferences for Print and PDF. It makes sure that there is a printable area of at least 0.5 inches. It also checks that the value is within the min and max settings specified.

  • Type: real
  • Extra attributes: mn, mx

Summary

Constants
String Att_Max
String Att_Min
[Expand]
Inherited Constants
From class com.microstrategy.web.preferences.PreferenceDefinitionImpl
From interface com.microstrategy.web.preferences.PreferenceDefinition
[Expand]
Inherited Fields
From class com.microstrategy.web.preferences.PreferenceDefinitionBase
Public Constructors
PreferenceValidationForMargins()
Protected Methods
void buildXmlAttributes(XMLBuilder builder)
Constructs an XML representation of the preference definition.
void setAttributes(Attributes attrs, PreferenceLevels group, boolean update)
Populates the object with attributes from parsing the definition XML.
String validateTransmute(String value, Preferences pref, Object validationObject)
This method is triggered by callback when setting preference values.
[Expand]
Inherited Methods
From class com.microstrategy.web.preferences.PreferenceDefinitionImpl
From class com.microstrategy.web.preferences.PreferenceDefinitionBase
From class java.lang.Object
From interface com.microstrategy.web.preferences.PreferenceDefinition

Constants

public static final String Att_Max

Constant Value: "mx"

public static final String Att_Min

Constant Value: "mn"

Public Constructors

public PreferenceValidationForMargins ()

Protected Methods

protected void buildXmlAttributes (XMLBuilder builder)

Constructs an XML representation of the preference definition. Persists the following attributes: name, value, description, type, scope, and the implementation class of PreferenceDefinition (omitted if PreferenceDefinitionImpl).

protected void setAttributes (Attributes attrs, PreferenceLevels group, boolean update)

Populates the object with attributes from parsing the definition XML. The attributes populated by PreferenceDefinitionImpl are as follows: name, value, description, type, scope, and the preference levels grouping.

Parameters
attrs properties of the definition in XML form.
group used to check the scope of the definition.
Throws
PreferencesException

protected String validateTransmute (String value, Preferences pref, Object validationObject)

This method is triggered by callback when setting preference values. By default, this method doesn't do anything. The returned value will be used to set the preference value - this facilitates preprocessing such as trimming strings, or date time reformating.

Returns
  • transmuted preference value
Throws
PreferencesException