jet.server.api.admin.cfg
Interface ConfigurationPrecisionMapping

public interface ConfigurationPrecisionMapping

The result format and precision mapping settings for the FR220 feature(font precision).

Each result format has a precision value, and client can get/set precision through this interface.
For any format, there is always a default precision.

The valid precision is:
APIConst.PRECISION_HIGH: the High precision is required for the result format.
APIConst.PRECISION_LOW: the Low precision is required for the result format.
APIConst.PRECISION_ANY: the context precision can be Any(High or Low). Don't care the precision issue for the result format.

The valid formats is:
APIConst.RST, APIConst.HTML, APIConst.PDF, APIConst.TEXT, APIConst.EXCEL, APIConst.PS, APIConst.RTF, APIConst.XML, APIConst.DHTML, APIConst.PRINTER, APIConst.FAX
Notes: Applet is RST(RST)

Since:

8.1

Method Summary

void	enableCustomizedPrecision(boolean isCustomized) Enables or disables the customized precision.
void	enableFormatCustomizedPrecision(int format, boolean isCustomized) Enables or disables the customized precision for the format.
int	getCustomizedPrecision(int format) Gets the customized precision.
int	getPrecision(int format) Gets the precision.
boolean	isFormatPrecisionCustomized(int format) Checks whether to enable the customized precision for the format.
boolean	isPrecisionCustomized() Checks whether to enable customized precision.
void	setPrecision(int format, int precision) Sets the precision.

Method Detail

getPrecision

int getPrecision(int format)

Gets the precision.
If the format is invalid the APIConst.PRECISION_ANY will be returned.

Notes: if isPrecisionCustomized() is true and isFormatPrecisionCustomized(int) is true, it will return the customized precision, otherwise, the default system precision.

Parameters:

format - the format, can be one of the followings:
APIConst.RST, APIConst.HTML, APIConst.PDF, APIConst.TEXT, APIConst.EXCEL, APIConst.PS, APIConst.RTF, APIConst.XML, APIConst.DHTML, APIConst.PRINTER, APIConst.FAX

Returns:

the precision, can be one of following:
APIConst.PRECISION_LOW, APIConst.PRECISION_HIGH, APIConst.PRECISION_ANY

setPrecision

void setPrecision(int format,
                  int precision)

Sets the precision.
If the format(or precision) is invalid value, it will not be thrown, just no effect.

Parameters:

format - the format, can be one of following:
APIConst.RST, APIConst.HTML, APIConst.PDF, APIConst.TEXT, APIConst.EXCEL, APIConst.PS, APIConst.RTF, APIConst.XML, APIConst.DHTML, APIConst.PRINTER, APIConst.FAX

precision - the precision, can be one of following:
APIConst.PRECISION_LOW, APIConst.PRECISION_HIGH

enableCustomizedPrecision

void enableCustomizedPrecision(boolean isCustomized)

Enables or disables the customized precision.

Parameters:

isCustomized -

isPrecisionCustomized

boolean isPrecisionCustomized()

Checks whether to enable customized precision.

Returns:

whether to allow the customized precision.

enableFormatCustomizedPrecision

void enableFormatCustomizedPrecision(int format,
                                     boolean isCustomized)

Enables or disables the customized precision for the format.

Parameters:

format - APIConst.HTML etc.

isCustomized -

isFormatPrecisionCustomized

boolean isFormatPrecisionCustomized(int format)

Checks whether to enable the customized precision for the format.

Parameters:

format - APIConst.HTML etc.

Returns:

whether to enable the customized precision for the format.

getCustomizedPrecision

int getCustomizedPrecision(int format)

Gets the customized precision.

Parameters:

format - the format.

Returns:

the customized precision.