io.jmix.core.credits

Class CreditsLoader

java.lang.Object

io.jmix.core.credits.CreditsLoader

@Component(value="core_CreditsLoader")
public class CreditsLoader
extends java.lang.Object

Provides information about third-party software by loading credits.xml files of Jmix modules.

Example usage:

 @Autowired
 private CreditsLoader creditsLoader;
 @Autowired
 private Downloader downloader;

 public void showCredits() {
     byte[] html = creditsLoader.getCreditsHtml(true);
     downloader.download(html, "credits.html");
 }
 

See Also:

getCredits(), getCreditsHtml(boolean)

Constructor Summary

Constructors

Constructor and Description
CreditsLoader()

Method Summary

Modifier and Type	Method and Description
java.util.List<CreditsItem>	getCredits() Returns credits as a list of CreditsItem objects.
byte[]	getCreditsHtml(boolean completePage) Returns credits as a byte array containing an HTML document rendered using CreditsHtmlRenderer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreditsLoader

public CreditsLoader()

Method Detail

getCredits

public java.util.List<CreditsItem> getCredits()

Returns credits as a list of CreditsItem objects.

getCreditsHtml

public byte[] getCreditsHtml(boolean completePage)

Returns credits as a byte array containing an HTML document rendered using CreditsHtmlRenderer.

Parameters:

completePage - if true, renders the complete page with html, header and body. Otherwise, returns an HTML table only.