org.apache.poi.hwmf.record

Enum HwmfEscape.EscapeFunction

java.lang.Object

java.lang.Enum<HwmfEscape.EscapeFunction>

org.apache.poi.hwmf.record.HwmfEscape.EscapeFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable< HwmfEscape.EscapeFunction>

Enclosing class:

HwmfEscape

public static enum HwmfEscape.EscapeFunction
extends java.lang.Enum<HwmfEscape.EscapeFunction>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTDOC Stops processing the current document.
BANDINFO Retrieves or specifies settings concerning banding on a device, such as the number of bands.
BEGIN_PATH Opens a path.
CHECKJPEGFORMAT Checks whether the printer supports a JPEG image.
CHECKPNGFORMAT Checks whether the printer supports a PNG image
CLIP_TO_PATH Defines a clip region that is bounded by a path.
CLOSE_CHANNEL The same as ENDDOC.
DOWNLOADFACE Sets the font face name on a device.
DOWNLOADHEADER Instructs the printer driver to download sets of PostScript procedures.
DRAFTMODE Indicates that the printer driver SHOULD print text only, and no graphics.
DRAWPATTERNRECT Draws a rectangle with a defined pattern.
ENABLEDUPLEX Enables or disables double-sided (duplex) printing on a device.
ENCAPSULATED_POSTSCRIPT Sends arbitrary data directly to the printer driver.
END_PATH Ends a path.
ENDDOC Notifies the printer driver that the current print job is ending.
ENUMPAPERBINS Retrieves information concerning the sources of different forms on an output device.
ENUMPAPERMETRICS Queries a printer driver for paper dimensions and other forms data.
EPSPRINTING Indicates the start and end of an encapsulated PostScript (EPS) section.
EXTTEXTOUT Draws text using the currently selected font, background color, and text color.
FLUSHOUT Causes all pending output to be flushed to the output device.
GET_PS_FEATURESETTING Gets information on a specified feature setting for a PostScript printer driver.
GETCOLORTABLE Gets color table values.
GETDEVICEUNITS Gets the device units currently configured on an output device.
GETEXTENDEDTEXTMETRICS Gets extended text metrics currently configured on an output device.
GETFACENAME Gets the font face name currently configured on a device.
GETPAIRKERNTABLE Gets the font kern table currently defined on an output device.
GETPHYSPAGESIZE Retrieves the physical page size currently selected on an output device.
GETPRINTINGOFFSET Retrieves the offset from the upper-left corner of the physical page where the actual printing or drawing begins.
GETSCALINGFACTOR Retrieves the scaling factors for the x-axis and the y-axis of a printer.
GETSETPAPERBINS Retrieves or specifies the source of output forms on a device.
GETSETPAPERMETRICS Retrieves or specifies paper dimensions and other forms data on an output device.
GETSETPRINTORIENT Retrieves or specifies the paper orientation on a device.
GETTECHNOLOGY Gets information concerning graphics technology that is supported on a device.
GETVECTORBRUSHSIZE Retrieves the physical brush size currently defined on a device.
GETVECTORPENSIZE Retrieves the physical pen size currently defined on a device.
META_ESCAPE_ENHANCED_METAFILE Used to embed an enhanced metafile format (EMF) metafile within a WMF metafile.
METAFILE_DRIVER Queries a printer driver about the support for metafiles on an output device.
MXDC_ESCAPE Enables applications to write documents to a file or to a printer in XML Paper Specification (XPS) format.
NEWFRAME Notifies the printer driver that the application has finished writing to a page.
NEXTBAND Notifies the printer driver that the application has finished writing to a band.
OPEN_CHANNEL The same as STARTDOC specified with a NULL document and output filename, data in raw mode, and a type of zero.
PASSTHROUGH This record passes through arbitrary data.
POSTSCRIPT_DATA Sends arbitrary PostScript data to an output device.
POSTSCRIPT_IDENTIFY Sets the printer driver to either PostScript or GDI mode.
POSTSCRIPT_IGNORE Notifies an output device to ignore PostScript data.
POSTSCRIPT_INJECTION Inserts a block of raw data into a PostScript stream.
POSTSCRIPT_PASSTHROUGH Sends arbitrary data directly to a printer driver, which is expected to process this data only when in PostScript mode.
QUERYDIBSUPPORT Queries the printer driver about its support for DIBs on an output device.
QUERYESCSUPPORT Queries a printer driver to determine whether a specific escape function is supported on the output device it drives.
SETABORTPROC Sets the application-defined function that allows a print job to be canceled during printing.
SETCOLORTABLE Sets color table values.
SETCOPYCOUNT Sets the number of copies.
SETDIBSCALING Specifies the scaling of device-independent bitmaps (DIBs).
SETLINECAP Specifies the line-drawing mode to use in output to a device.
SETLINEJOIN Specifies the line-joining mode to use in output to a device.
SETMITERLIMIT Sets the limit for the length of miter joins to use in output to a device.
SETPAPERSOURCE Sets the source, such as a particular paper tray or bin on a printer, for output forms.
SETPENWIDTH Sets the width of a pen in pixels.
SPCLPASSTHROUGH2 Enables applications to include private procedures and other arbitrary data in documents.
STARTDOC Notifies the printer driver that a new print job is starting.

Method Summary

Modifier and Type	Method and Description
java.util.function.Supplier<? extends HwmfEscape.HwmfEscapeData>	getConstructor()
int	getFlag()
static HwmfEscape.EscapeFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name. (返回具有指定名称的此类型的枚举常量。)
static HwmfEscape.EscapeFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared. (按照声明的顺序返回包含此枚举类型常量的数组。)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEWFRAME

public static final HwmfEscape.EscapeFunction NEWFRAME

Notifies the printer driver that the application has finished writing to a page. (通知打印机驱动程序应用程序已完成对页面的写入。)

ABORTDOC

public static final HwmfEscape.EscapeFunction ABORTDOC

Stops processing the current document. (停止处理当前文档。)

NEXTBAND

public static final HwmfEscape.EscapeFunction NEXTBAND

Notifies the printer driver that the application has finished writing to a band. (通知打印机驱动程序应用程序已完成写入带区。)

SETCOLORTABLE

public static final HwmfEscape.EscapeFunction SETCOLORTABLE

Sets color table values. (设置颜色表值。)

GETCOLORTABLE

public static final HwmfEscape.EscapeFunction GETCOLORTABLE

Gets color table values. (获取颜色表值。)

FLUSHOUT

public static final HwmfEscape.EscapeFunction FLUSHOUT

Causes all pending output to be flushed to the output device. (使所有挂起的输出刷新到输出设备。)

DRAFTMODE

public static final HwmfEscape.EscapeFunction DRAFTMODE

Indicates that the printer driver SHOULD print text only, and no graphics. (表示打印机驱动程序应该只打印文本，不打印图形。)

QUERYESCSUPPORT

public static final HwmfEscape.EscapeFunction QUERYESCSUPPORT

Queries a printer driver to determine whether a specific escape function is supported on the output device it drives. (查询打印机驱动程序以确定其驱动的输出设备是否支持特定的转义函数。)

SETABORTPROC

public static final HwmfEscape.EscapeFunction SETABORTPROC

Sets the application-defined function that allows a print job to be canceled during printing. (设置允许在打印期间取消打印作业的应用程序定义功能。)

STARTDOC

public static final HwmfEscape.EscapeFunction STARTDOC

Notifies the printer driver that a new print job is starting. (通知打印机驱动程序新的打印作业正在开始。)

ENDDOC

public static final HwmfEscape.EscapeFunction ENDDOC

Notifies the printer driver that the current print job is ending. (通知打印机驱动程序当前打印作业即将结束。)

GETPHYSPAGESIZE

public static final HwmfEscape.EscapeFunction GETPHYSPAGESIZE

Retrieves the physical page size currently selected on an output device. (检索当前在输出设备上选择的物理页面大小。)

GETPRINTINGOFFSET

public static final HwmfEscape.EscapeFunction GETPRINTINGOFFSET

Retrieves the offset from the upper-left corner of the physical page where the actual printing or drawing begins. (从实际打印或绘图开始的物理页面的左上角检索偏移量。)

GETSCALINGFACTOR

public static final HwmfEscape.EscapeFunction GETSCALINGFACTOR

Retrieves the scaling factors for the x-axis and the y-axis of a printer. (检索打印机的 x 轴和 y 轴的比例因子。)

META_ESCAPE_ENHANCED_METAFILE

public static final HwmfEscape.EscapeFunction META_ESCAPE_ENHANCED_METAFILE

Used to embed an enhanced metafile format (EMF) metafile within a WMF metafile. (用于在 WMF 图元文件中嵌入增强型图元文件格式 (EMF) 图元文件。)

SETPENWIDTH

public static final HwmfEscape.EscapeFunction SETPENWIDTH

Sets the width of a pen in pixels. (以像素为单位设置画笔的宽度。)

SETCOPYCOUNT

public static final HwmfEscape.EscapeFunction SETCOPYCOUNT

Sets the number of copies. (设置份数。)

SETPAPERSOURCE

public static final HwmfEscape.EscapeFunction SETPAPERSOURCE

Sets the source, such as a particular paper tray or bin on a printer, for output forms. (设置输出表单的来源，例如打印机上的特定纸盘或纸盒。)

PASSTHROUGH

public static final HwmfEscape.EscapeFunction PASSTHROUGH

This record passes through arbitrary data. (该记录通过任意数据。)

GETTECHNOLOGY

public static final HwmfEscape.EscapeFunction GETTECHNOLOGY

Gets information concerning graphics technology that is supported on a device. (获取有关设备支持的图形技术的信息。)

SETLINECAP

public static final HwmfEscape.EscapeFunction SETLINECAP

Specifies the line-drawing mode to use in output to a device. (指定在输出到设备时使用的画线模式。)

SETLINEJOIN

public static final HwmfEscape.EscapeFunction SETLINEJOIN

Specifies the line-joining mode to use in output to a device. (指定在输出到设备时使用的行连接模式。)

SETMITERLIMIT

public static final HwmfEscape.EscapeFunction SETMITERLIMIT

Sets the limit for the length of miter joins to use in output to a device. (设置用于输出到设备的斜接连接长度的限制。)

BANDINFO

public static final HwmfEscape.EscapeFunction BANDINFO

Retrieves or specifies settings concerning banding on a device, such as the number of bands. (检索或指定与设备上的波段相关的设置，例如波段数。)

DRAWPATTERNRECT

public static final HwmfEscape.EscapeFunction DRAWPATTERNRECT

Draws a rectangle with a defined pattern. (绘制具有定义图案的矩形。)

GETVECTORPENSIZE

public static final HwmfEscape.EscapeFunction GETVECTORPENSIZE

Retrieves the physical pen size currently defined on a device. (检索当前在设备上定义的物理笔大小。)

GETVECTORBRUSHSIZE

public static final HwmfEscape.EscapeFunction GETVECTORBRUSHSIZE

Retrieves the physical brush size currently defined on a device. (检索当前在设备上定义的物理画笔大小。)

ENABLEDUPLEX

public static final HwmfEscape.EscapeFunction ENABLEDUPLEX

Enables or disables double-sided (duplex) printing on a device. (在设备上启用或禁用双面（双面）打印。)

GETSETPAPERBINS

public static final HwmfEscape.EscapeFunction GETSETPAPERBINS

Retrieves or specifies the source of output forms on a device. (检索或指定设备上输出表单的来源。)

GETSETPRINTORIENT

public static final HwmfEscape.EscapeFunction GETSETPRINTORIENT

Retrieves or specifies the paper orientation on a device. (检索或指定设备上的纸张方向。)

ENUMPAPERBINS

public static final HwmfEscape.EscapeFunction ENUMPAPERBINS

Retrieves information concerning the sources of different forms on an output device. (检索有关输出设备上不同形式的来源的信息。)

SETDIBSCALING

public static final HwmfEscape.EscapeFunction SETDIBSCALING

Specifies the scaling of device-independent bitmaps (DIBs). (指定与设备无关的位图 (DIB) 的缩放比例。)

EPSPRINTING

public static final HwmfEscape.EscapeFunction EPSPRINTING

Indicates the start and end of an encapsulated PostScript (EPS) section. (指示封装 PostScript (EPS) 部分的开始和结束。)

ENUMPAPERMETRICS

public static final HwmfEscape.EscapeFunction ENUMPAPERMETRICS

Queries a printer driver for paper dimensions and other forms data. (查询打印机驱动程序以获取纸张尺寸和其他表单数据。)

GETSETPAPERMETRICS

public static final HwmfEscape.EscapeFunction GETSETPAPERMETRICS

Retrieves or specifies paper dimensions and other forms data on an output device. (在输出设备上检索或指定纸张尺寸和其他表格数据。)

POSTSCRIPT_DATA

public static final HwmfEscape.EscapeFunction POSTSCRIPT_DATA

Sends arbitrary PostScript data to an output device. (将任意 PostScript 数据发送到输出设备。)

POSTSCRIPT_IGNORE

public static final HwmfEscape.EscapeFunction POSTSCRIPT_IGNORE

Notifies an output device to ignore PostScript data. (通知输出设备忽略 PostScript 数据。)

GETDEVICEUNITS

public static final HwmfEscape.EscapeFunction GETDEVICEUNITS

Gets the device units currently configured on an output device. (获取当前在输出设备上配置的设备单元。)

GETEXTENDEDTEXTMETRICS

public static final HwmfEscape.EscapeFunction GETEXTENDEDTEXTMETRICS

Gets extended text metrics currently configured on an output device. (获取当前在输出设备上配置的扩展文本指标。)

GETPAIRKERNTABLE

public static final HwmfEscape.EscapeFunction GETPAIRKERNTABLE

Gets the font kern table currently defined on an output device. (获取当前在输出设备上定义的字体紧缩表。)

EXTTEXTOUT

public static final HwmfEscape.EscapeFunction EXTTEXTOUT

Draws text using the currently selected font, background color, and text color. (使用当前选定的字体、背景颜色和文本颜色绘制文本。)

GETFACENAME

public static final HwmfEscape.EscapeFunction GETFACENAME

Gets the font face name currently configured on a device. (获取设备上当前配置的字体名称。)

DOWNLOADFACE

public static final HwmfEscape.EscapeFunction DOWNLOADFACE

Sets the font face name on a device. (在设备上设置字体名称。)

METAFILE_DRIVER

public static final HwmfEscape.EscapeFunction METAFILE_DRIVER

Queries a printer driver about the support for metafiles on an output device. (查询打印机驱动程序是否支持输出设备上的元文件。)

QUERYDIBSUPPORT

public static final HwmfEscape.EscapeFunction QUERYDIBSUPPORT

Queries the printer driver about its support for DIBs on an output device. (查询打印机驱动程序是否支持输出设备上的 DIB。)

BEGIN_PATH

public static final HwmfEscape.EscapeFunction BEGIN_PATH

Opens a path. (打开一条路径。)

CLIP_TO_PATH

public static final HwmfEscape.EscapeFunction CLIP_TO_PATH

Defines a clip region that is bounded by a path. The input MUST be a 16-bit quantity that defines the action to take. (定义由路径界定的剪辑区域。输入必须是定义要采取的操作的 16 位数量。)

END_PATH

public static final HwmfEscape.EscapeFunction END_PATH

Ends a path. (结束一个路径。)

OPEN_CHANNEL

public static final HwmfEscape.EscapeFunction OPEN_CHANNEL

The same as STARTDOC specified with a NULL document and output filename, data in raw mode, and a type of zero. (与使用 NULL 文档和输出文件名、原始模式下的数据和零类型指定的 STARTDOC 相同。)

DOWNLOADHEADER

public static final HwmfEscape.EscapeFunction DOWNLOADHEADER

Instructs the printer driver to download sets of PostScript procedures. (指示打印机驱动程序下载 PostScript 程序集。)

CLOSE_CHANNEL

public static final HwmfEscape.EscapeFunction CLOSE_CHANNEL

The same as ENDDOC. See OPEN_CHANNEL. (与 ENDDOC 相同。请参阅 OPEN_CHANNEL。)

POSTSCRIPT_PASSTHROUGH

public static final HwmfEscape.EscapeFunction POSTSCRIPT_PASSTHROUGH

Sends arbitrary data directly to a printer driver, which is expected to process this data only when in PostScript mode. (将任意数据直接发送到打印机驱动程序，预计仅在 PostScript 模式下才会处理此数据。)

ENCAPSULATED_POSTSCRIPT

public static final HwmfEscape.EscapeFunction ENCAPSULATED_POSTSCRIPT

Sends arbitrary data directly to the printer driver. (将任意数据直接发送到打印机驱动程序。)

POSTSCRIPT_IDENTIFY

public static final HwmfEscape.EscapeFunction POSTSCRIPT_IDENTIFY

Sets the printer driver to either PostScript or GDI mode. (将打印机驱动程序设置为 PostScript 或 GDI 模式。)

POSTSCRIPT_INJECTION

public static final HwmfEscape.EscapeFunction POSTSCRIPT_INJECTION

Inserts a block of raw data into a PostScript stream. The input MUST be a 32-bit quantity specifying the number of bytes to inject, a 16-bit quantity specifying the injection point, and a 16-bit quantity specifying the page number, followed by the bytes to inject. (将原始数据块插入 PostScript 流。输入必须是指定要注入的字节数的 32 位数量，指定注入点的 16 位数量，以及指定页号的 16 位数量，后跟要注入的字节数。)

CHECKJPEGFORMAT

public static final HwmfEscape.EscapeFunction CHECKJPEGFORMAT

Checks whether the printer supports a JPEG image. (检查打印机是否支持 JPEG 图像。)

CHECKPNGFORMAT

public static final HwmfEscape.EscapeFunction CHECKPNGFORMAT

Checks whether the printer supports a PNG image (检查打印机是否支持 PNG 图像)

GET_PS_FEATURESETTING

public static final HwmfEscape.EscapeFunction GET_PS_FEATURESETTING

Gets information on a specified feature setting for a PostScript printer driver. (获取有关 PostScript 打印机驱动程序的指定功能设置的信息。)

MXDC_ESCAPE

public static final HwmfEscape.EscapeFunction MXDC_ESCAPE

Enables applications to write documents to a file or to a printer in XML Paper Specification (XPS) format. (使应用程序能够以 XML 纸张规范 (XPS) 格式将文档写入文件或打印机。)

SPCLPASSTHROUGH2

public static final HwmfEscape.EscapeFunction SPCLPASSTHROUGH2

Enables applications to include private procedures and other arbitrary data in documents. (使应用程序能够在文档中包含私有过程和其他任意数据。)

Method Detail

values

public static HwmfEscape.EscapeFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HwmfEscape.EscapeFunction c : HwmfEscape.EscapeFunction.values())
    System.out.println(c);

(按照声明的顺序返回包含此枚举类型常量的数组。此方法可用于迭代常量，如下所示： for (HwmfEscape.EscapeFunction c : HwmfEscape.EscapeFunction.values()) System.out.println(c);)

Returns:

an array containing the constants of this enum type, in the order they are declared (包含此枚举类型的常量的数组，按声明的顺序排列)

valueOf

public static HwmfEscape.EscapeFunction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) (返回具有指定名称的此类型的枚举常量。该字符串必须与用于在此类型中声明枚举常量的标识符完全匹配。 （不允许使用无关的空白字符。）)

Parameters:

name - the name of the enum constant to be returned. (name - 要返回的枚举常量的名称。)

Returns:

the enum constant with the specified name (具有指定名称的枚举常量)

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name (java.lang.IllegalArgumentException - 如果此枚举类型没有具有指定名称的常量)

java.lang.NullPointerException - if the argument is null (java.lang.NullPointerException - 如果参数为空)

getFlag

public int getFlag()

getConstructor

public java.util.function.Supplier<? extends HwmfEscape.HwmfEscapeData> getConstructor()