java.lang.Object
- de.xima.fc.gui.designer.form.bean.PdfImportBean

All Implemented Interfaces:

Serializable
```
@ViewScoped
@Named
public class PdfImportBean
extends Object
implements Serializable
```
Controller bean for the PDF form importer.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

PdfImportBean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getLocalizedItemName(String className)`	Finds the localized name for the the given formcycle form element type.
`String`	`getPassword()`
`String`	`getPdfHeaderInfoMain()`
`String`	`getPdfHeaderInfoSub()`
`com.alibaba.fastjson.JSONObject`	`getXItemDescription()`
`boolean`	`isHasLoadedPdf()`
`void`	`loadPageHtml()`	Retrieves the HTML for the given PDF page or pages.
`void`	`onImportIdReceived()`	Remote command when a new PDF file was sent to the designer via the conversation context and the PDF importer needs to be initialized.
`void`	`onPageLoad()`	Callback invoked via a view action on page load.
`void`	`onPasswordEntered()`	When the PDF requires a password and the user entered the password.
`void`	`onSessionKeyReceived()`	Remote command when a session key was received.
`void`	`onUploadPdf(org.primefaces.event.FileUploadEvent event)`	When a PDF file was upload directly and the PDF importer needs to be initialized.
`void`	`requestInsertFormElement()`	Inserts a form element into the form designer.
`void`	`requestOpenInlineViaSessionKey()`	Open the inline PDF importer and loads the given PDF import session.
`void`	`requestPdfImporterIds()`	Finds the PDF importer IDs of existing elements.
`void`	`sendRemovedPdfImporterIds()`	Remote command when an item was removed from the designer form that was originally imported from the PDF document.
`void`	`setPassword(String password)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PdfImportBean
```
public PdfImportBean()
```
- Method Detail
  - getLocalizedItemName
```
public String getLocalizedItemName(String className)
```
    Finds the localized name for the the given formcycle form element type.
    
    Parameters:
    
    className - Name of the form element type.
    
    Returns:
    
    The localized name for the given form element type.
  - getPassword
```
public String getPassword()
```
    Returns:
    
    The password for the PDF document as entered by the user.
  - getPdfHeaderInfoMain
```
public String getPdfHeaderInfoMain()
```
    Returns:
    
    Basic info about the PDF displayed in the header topbar.
  - getPdfHeaderInfoSub
```
public String getPdfHeaderInfoSub()
```
    Returns:
    
    Additional info about the PDF displayed in the header topbar.
  - getXItemDescription
```
public com.alibaba.fastjson.JSONObject getXItemDescription()
```
    Returns:
    
    The description with the icon for each available form field type.
  - isHasLoadedPdf
```
public boolean isHasLoadedPdf()
```
    Returns:
    
    Whether PDF document is currently loaded and is available for editing.
  - loadPageHtml
```
public void loadPageHtml()
```
    Retrieves the HTML for the given PDF page or pages.
  - onImportIdReceived
```
public void onImportIdReceived()
```
    Remote command when a new PDF file was sent to the designer via the conversation context and the PDF importer needs to be initialized.
  - onPageLoad
```
public void onPageLoad()
```
    Callback invoked via a view action on page load. Initializes all data required for the form designer.
  - onPasswordEntered
```
public void onPasswordEntered()
```
    When the PDF requires a password and the user entered the password. Attempts to load the PDF document with the given password.
  - onSessionKeyReceived
```
public void onSessionKeyReceived()
```
    Remote command when a session key was received. Opens the importer and loads the given PDF import session.
  - onUploadPdf
```
public void onUploadPdf(org.primefaces.event.FileUploadEvent event)
```
    When a PDF file was upload directly and the PDF importer needs to be initialized.
    
    Parameters:
    
    event - File upload even with the uploaded PDF.
  - requestInsertFormElement
```
public void requestInsertFormElement()
```
    Inserts a form element into the form designer.
  - requestOpenInlineViaSessionKey
```
public void requestOpenInlineViaSessionKey()
```
    Open the inline PDF importer and loads the given PDF import session.
  - requestPdfImporterIds
```
public void requestPdfImporterIds()
```
    Finds the PDF importer IDs of existing elements.
  - sendRemovedPdfImporterIds
```
public void sendRemovedPdfImporterIds()
```
    Remote command when an item was removed from the designer form that was originally imported from the PDF document. Sends an event with the IDs to all open PDF importers.
  - setPassword
```
public void setPassword(String password)
```
    Parameters:
    
    password - The password for the PDF document as entered by the user.

Class PdfImportBean

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PdfImportBean

Method Detail

getLocalizedItemName

getPassword

getPdfHeaderInfoMain

getPdfHeaderInfoSub

getXItemDescription

isHasLoadedPdf

loadPageHtml

onImportIdReceived

onPageLoad

onPasswordEntered

onSessionKeyReceived

onUploadPdf

requestInsertFormElement

requestOpenInlineViaSessionKey

requestPdfImporterIds

sendRemovedPdfImporterIds

setPassword