com.groupdocs.viewer.results

Class Resource

java.lang.Object

com.groupdocs.viewer.results.Resource

All Implemented Interfaces:

Serializable

public class Resource
extends Object
implements Serializable

Represents HTML resource such as font, style, image or graphics.

The Resource class represents a resource used in HTML rendering in the GroupDocs.Viewer component. It can represent various types of resources, such as fonts, styles, images, or graphics, that are included or referenced in the generated HTML output during the rendering process.

Example usage:

{@code
 final HtmlViewOptions htmlViewOptions = HtmlViewOptions.forExternalResources(pageNumber -> , new ReleaseResourceStream() {

See Also:

Viewer, HtmlViewOptions, ReleaseResourceStream, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Resource(String fileName, boolean nested) Creates a new instance of the Resource class.

Method Summary

Modifier and Type	Method and Description
String	getFileName() Returns the file name of the resource.
boolean	isNested() Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource.
void	setFileName(String fileName) Sets the file name of the resource.
void	setNested(boolean nested) Sets whether the resource resides inside another resource.
String	toString() Returns a string that represents the current object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resource

public Resource(String fileName,
                boolean nested)

Creates a new instance of the Resource class.

Parameters:

fileName - The resource file name.

nested - Indicates whether the resource resides inside another resource, e.g., a font resource that resides in a CSS or SVG resource.

Throws:

IllegalArgumentException - Thrown when the fileName is null or empty.

Method Detail

getFileName

public final String getFileName()

Returns the file name of the resource.

Returns:

the file name of the resource.

isNested

public final boolean isNested()

Returns whether the resource resides inside another resource, e.g. a font resource that resides in a CSS or SVG resource.

Returns:

Whether the resource resides inside another resource.

setFileName

public void setFileName(String fileName)

Sets the file name of the resource.

Parameters:

fileName - The new file name for the resource.

setNested

public void setNested(boolean nested)

Sets whether the resource resides inside another resource.

Parameters:

nested - Whether the resource should be set as nested.

toString

public String toString()

Returns a string that represents the current object.

Overrides:

toString in class Object

Returns:

the string representation of the current object.