Package de.xima.fc.workflow.designer.model

Class FileDescriptorRow

java.lang.Object

de.xima.fc.workflow.designer.model.FileDescriptorRow

All Implemented Interfaces:

Serializable

public final class FileDescriptorRow
extends Object
implements Serializable

View model for the workflow designer, used in the info panel of a node or trigger. Models a single row of the table with the files provided by the node or trigger (if any). See IFileValueDescriptor.

Since:

8.2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FileDescriptorRow()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	The description of the files the node or trigger provides for the getKey().
String	getDetails()	Detail text of the file the node or trigger provides, such as the content types or the min and max number of files.
String	getKey()	The key of the file, corresponding to a key in the IFileValueDescriptor.getFiles() map.
boolean	isDescriptionHtml()	Whether the getDescription() is an HTML string (make sure it is valid HTML and properly escaped!).
void	setDescription(String description)	The description of the files the node or trigger provides for the getKey().
void	setDescriptionHtml(boolean descriptionHtml)	Whether the getDescription() is an HTML string (make sure it is valid HTML and properly escaped!).
void	setDetails(String details)	Detail text of the file the node or trigger provides, such as the content types or the min and max number of files.
void	setKey(String key)	The key of the file, corresponding to a key in the IFileValueDescriptor.getFiles() map.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDescriptorRow

public FileDescriptorRow()

Method Detail

getDescription

public String getDescription()

The description of the files the node or trigger provides for the getKey(). See IFileListDescriptor.getDescription().

Returns:

Description of the files.

setDescription

public void setDescription(String description)

The description of the files the node or trigger provides for the getKey(). See IFileListDescriptor.getDescription().

Parameters:

description - Description of the files.

getDetails

public String getDetails()

Detail text of the file the node or trigger provides, such as the content types or the min and max number of files. Used as the title when hovering over a row with the mouse.

Returns:

File details.

setDetails

public void setDetails(String details)

Detail text of the file the node or trigger provides, such as the content types or the min and max number of files. Used as the title when hovering over a row with the mouse.

Parameters:

details - File details.

getKey

public String getKey()

The key of the file, corresponding to a key in the IFileValueDescriptor.getFiles() map. DEFAULT_FILE_KEY is the default (unscoped) key.

Returns:

The file key.

setKey

public void setKey(String key)

The key of the file, corresponding to a key in the IFileValueDescriptor.getFiles() map. DEFAULT_FILE_KEY is the default (unscoped) key.

Parameters:

key - The file key.

isDescriptionHtml

public boolean isDescriptionHtml()

Whether the getDescription() is an HTML string (make sure it is valid HTML and properly escaped!). When false, the description is treated as plain text.

Returns:

Whether the description is an HTML string.

setDescriptionHtml

public void setDescriptionHtml(boolean descriptionHtml)

Whether the getDescription() is an HTML string (make sure it is valid HTML and properly escaped!). When false, the description is treated as plain text.

Parameters:

descriptionHtml - Whether the description is an HTML string.