FixedLayoutFormats
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.formats.IDocumentFormat
public class FixedLayoutFormats implements IDocumentFormat
Encapsulates all fixed-layout (also know as “fixed-page”) formats, which includes PDF and XPS (this does not include raster images)
Various document viewing or publishing applications allow users to open (Adobe Acrobat, XPS Viewer), and sometimes edit (Adobe InDesign) documents of specific formats. These applications typically produce so-called \u201cfixed-page\u201d format documents. Such a document format describes precisely where a document\u2019s content is placed on every page. Internally, the PDF or XPS format contains a description of every page, as well as drawing instructions, specifying the layout of the content on the page. This is similar to image formats, describing where the content is shown either in raster or vector form.
Constructors
| Constructor | Description |
|---|---|
| FixedLayoutFormats() |
Fields
| Field | Description |
|---|---|
| Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. | |
| Xps | XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. |
| All | Returns an internal class, that provides enumerable possibilities over all existing fixed-layout formats |
Methods
| Method | Description |
|---|---|
| getName() | Returns a formal full name of this fixed layout format |
| getExtension() | Returns an extension (without leading dot character) of this fixed-layout format in lower case |
| getMime() | Returns a MIME code for this format |
| toString() | Returns the name of this particular format, same as ‘Name’ property |
| op_Equality(FixedLayoutFormats first, FixedLayoutFormats second) | Checks two given FixedLayoutFormats instances on equality |
| op_Inequality(FixedLayoutFormats first, FixedLayoutFormats second) | Checks two given FixedLayoutFormats instances on inequality |
| equals(FixedLayoutFormats other) | Determines whether this instance is equal to the other specified FixedLayoutFormats instance |
| equals(IDocumentFormat other) | Determines whether this instance is equal to the other specified IDocumentFormat instance |
| equals(Object obj) | Determines whether this instance is equal to the other specified object, that is presumably of boxed FixedLayoutFormats |
| hashCode() | Returns a hash-code, that is immutable for this instance |
| to_Byte(FixedLayoutFormats input) | Returns a byte value from underlying field of specified FixedLayoutFormats instance |
| to_FixedLayoutFormats(byte raw) | Casts specified raw byte value to valid FixedLayoutFormats instance and returns it or throws an exception, is specified value is invalid |
| fromExtension(String extension) | Returns instance of FixedLayoutFormats structure, associated to specified filename extension, or throws an exception, if extension cannot be properly parsed |
FixedLayoutFormats()
public FixedLayoutFormats()
public static final FixedLayoutFormats Pdf
Portable Document Format (PDF) is a type of document created by Adobe back in 1990s. The purpose of this file format was to introduce a standard for representation of documents and other reference material in a format that is independent of application software, hardware as well as Operating System. Learn more about this file format here .
Xps
public static final FixedLayoutFormats Xps
XPS file represents page layout files that are based on XML Paper Specifications created by Microsoft. It was developed as a replacement of EMF file format and is similar to PDF file format, but uses XML in layout, appearance, and printing information of a document. Learn more about this file format here .
All
public static final FixedLayoutFormats.AllEnumerable All
Returns an internal class, that provides enumerable possibilities over all existing fixed-layout formats
getName()
public final String getName()
Returns a formal full name of this fixed layout format
Returns: java.lang.String
getExtension()
public final String getExtension()
Returns an extension (without leading dot character) of this fixed-layout format in lower case
Returns: java.lang.String
getMime()
public final String getMime()
Returns a MIME code for this format
Returns: java.lang.String
toString()
public String toString()
Returns the name of this particular format, same as ‘Name’ property
Returns: java.lang.String - A String that represents this instance
op_Equality(FixedLayoutFormats first, FixedLayoutFormats second)
public static boolean op_Equality(FixedLayoutFormats first, FixedLayoutFormats second)
Checks two given FixedLayoutFormats instances on equality
Parameters:
| Parameter | Type | Description |
|---|---|---|
| first | FixedLayoutFormats | First FixedLayoutFormats instance to check |
| second | FixedLayoutFormats | Second FixedLayoutFormats instance to check |
Returns: boolean - True if are equal, false if are unequal
op_Inequality(FixedLayoutFormats first, FixedLayoutFormats second)
public static boolean op_Inequality(FixedLayoutFormats first, FixedLayoutFormats second)
Checks two given FixedLayoutFormats instances on inequality
Parameters:
| Parameter | Type | Description |
|---|---|---|
| first | FixedLayoutFormats | First FixedLayoutFormats instance to check |
| second | FixedLayoutFormats | Second FixedLayoutFormats instance to check |
Returns: boolean - True if are not equal, false if are equal
equals(FixedLayoutFormats other)
public final boolean equals(FixedLayoutFormats other)
Determines whether this instance is equal to the other specified FixedLayoutFormats instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | FixedLayoutFormats | Other FixedLayoutFormats instance, that should be checked on equality with this |
Returns: boolean - True if are equal, false if are unequal
equals(IDocumentFormat other)
public final boolean equals(IDocumentFormat other)
Determines whether this instance is equal to the other specified IDocumentFormat instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | IDocumentFormat | Other IDocumentFormat instance. If it is not a FixedLayoutFormats, method will return ‘false’ |
Returns: boolean - True if are equal, false if are unequal
equals(Object obj)
public boolean equals(Object obj)
Determines whether this instance is equal to the other specified object, that is presumably of boxed FixedLayoutFormats
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | java.lang.Object | Other boxed FixedLayoutFormats instance |
Returns: boolean - True if are equal, false if are unequal
hashCode()
public int hashCode()
Returns a hash-code, that is immutable for this instance
Returns: int - Signed 4-byte integer
to_Byte(FixedLayoutFormats input)
public static byte to_Byte(FixedLayoutFormats input)
Returns a byte value from underlying field of specified FixedLayoutFormats instance
Parameters:
| Parameter | Type | Description |
|---|---|---|
| input | FixedLayoutFormats | Input FixedLayoutFormats instance |
Returns: byte
to_FixedLayoutFormats(byte raw)
public static FixedLayoutFormats to_FixedLayoutFormats(byte raw)
Casts specified raw byte value to valid FixedLayoutFormats instance and returns it or throws an exception, is specified value is invalid
Parameters:
| Parameter | Type | Description |
|---|---|---|
| raw | byte | Raw byte value |
Returns: FixedLayoutFormats
fromExtension(String extension)
public static FixedLayoutFormats fromExtension(String extension)
Returns instance of FixedLayoutFormats structure, associated to specified filename extension, or throws an exception, if extension cannot be properly parsed
Parameters:
| Parameter | Type | Description |
|---|---|---|
| extension | java.lang.String | Filename extension of any supportable FixedLayoutFormats format, with or without leading dot character, case-independent. Cannot be NULL or empty, should be valid. |
Returns: FixedLayoutFormats - Instance of FixedLayoutFormats structure on success or thrown exception on failure