Package com.microstrategy.web.preferences

Class PreferenceValidationForMargins

java.lang.Object

com.microstrategy.web.preferences.PreferenceDefinitionBase

com.microstrategy.web.preferences.PreferenceDefinitionImpl

com.microstrategy.web.preferences.PreferenceValidationForMargins

All Implemented Interfaces:

PreferenceDefinition

public class PreferenceValidationForMargins
extends PreferenceDefinitionImpl

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

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	Att_Max
static java.lang.String	Att_Min

Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl

Att_Class, Att_ClusterPropagate, Att_DescriptionID, Att_Scope, Tag_AllowableValue, Tag_AllowableValues

Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase

_allowableValues, _clusterPropagate, _description, _levels, _name, _scope, _type, _value

Fields inherited from interface com.microstrategy.web.preferences.PreferenceDefinition

TYPE_BOOLEAN, TYPE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
PreferenceValidationForMargins()

Method Summary

Modifier and Type	Method	Description
protected void	buildXmlAttributes(XMLBuilder builder)	Constructs an XML representation of the preference definition.
protected void	setAttributes(org.xml.sax.Attributes attrs, PreferenceLevels group, boolean update)	Populates the object with attributes from parsing the definition XML.
protected java.lang.String	validateTransmute(java.lang.String value, Preferences pref, java.lang.Object validationObject)	This method is triggered by callback when setting preference values.

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl

setAttributes, toString, validate, validateAllowableValues

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase

clusterPropagate, getAllowableValues, getDescription, getEnumPreferenceLevels, getName, getScope, getType, getValue, setClusterPropagate, setDescription, setEnumPreferenceLevels, setName, setScope, setType, setValue, validateDataType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Att_Min

public static final java.lang.String Att_Min

See Also:

Constant Field Values

Att_Max

public static final java.lang.String Att_Max

See Also:

Constant Field Values

Constructor Detail

PreferenceValidationForMargins

public PreferenceValidationForMargins()

Method Detail

validateTransmute

protected java.lang.String validateTransmute(java.lang.String value,
                                             Preferences pref,
                                             java.lang.Object validationObject)
                                      throws PreferencesException

Description copied from class: PreferenceDefinitionImpl

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.

Overrides:

validateTransmute in class PreferenceDefinitionImpl

Returns:

transmuted preference value

Throws:

PreferencesException

setAttributes

protected void setAttributes(org.xml.sax.Attributes attrs,
                             PreferenceLevels group,
                             boolean update)
                      throws PreferencesException

Description copied from class: PreferenceDefinitionImpl

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.

Overrides:

setAttributes in class PreferenceDefinitionImpl

Parameters:

attrs - properties of the definition in XML form.

group - used to check the scope of the definition.

Throws:

PreferencesException - if errors occur during the population.

Since:

MicroStrategy Web 9.0.1

See Also:

PreferenceDefinitionBase.setAttributes(Attributes, PreferenceLevels)

buildXmlAttributes

protected void buildXmlAttributes(XMLBuilder builder)

Description copied from class: PreferenceDefinitionImpl

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

Overrides:

buildXmlAttributes in class PreferenceDefinitionImpl

See Also:

PreferenceDefinitionBase.buildXmlAttributes(XMLBuilder)