org.openlowcode.server.graphic.widget

Class SFileDownloader

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SFileDownloader

public class SFileDownloader
extends SPageNode

a widget allowing to download a file from the server and open it in the client temp folder

Author:

Open Lowcode SAS

Field Summary

Fields inherited from class org.openlowcode.server.graphic.SPageNode

DEFAULT_UNSAVED_EDITION_CONTINUE_MESSAGE, DEFAULT_UNSAVED_EDITION_STOP_MESSAGE, DEFAULT_UNSAVED_EDITION_WARNING_MESSAGE

Constructor Summary

Constructors

Constructor and Description
SFileDownloader(java.lang.String id, SPage parentpage, SInlineActionRef filedownloadactionref, SActionOutputDataRef<LargeBinaryDataEltType> inlineoutputdata) creates a file downloader

Method Summary

Modifier and Type	Method and Description
java.lang.String	getWidgetCode()
boolean	hideComponent(SPageData input, SecurityBuffer buffer) This method allows to hide component in a layout if the user is not authorized
void	populateDown(SPageSignifPath parentpath, SPageNode[] widgetpathtoroot) this method should be recursively called from parent structure to all its children
void	WritePayloadToCDL(MessageWriter writer, SPageData input, SecurityBuffer buffer) writes the payload of the representation (without opening and closing structure)

Methods inherited from class org.openlowcode.server.graphic.SPageNode

addCurrentWidgetToRoot, getPage, printPath, setParentSignifPath, setSignifPath, WriteToCDL

Methods inherited from class java.lang.Object

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

Constructor Detail

SFileDownloader

public SFileDownloader(java.lang.String id,
                       SPage parentpage,
                       SInlineActionRef filedownloadactionref,
                       SActionOutputDataRef<LargeBinaryDataEltType> inlineoutputdata)

creates a file downloader

Parameters:

id - unique id of the download in the signifiant parent widget

parentpage - parent page

filedownloadactionref - reference of the action providing the file

inlineoutputdata - output data of the action providing the file to use as input for this component

Method Detail

populateDown

public void populateDown(SPageSignifPath parentpath,
                         SPageNode[] widgetpathtoroot)

Description copied from class: SPageNode

this method should be recursively called from parent structure to all its children

Specified by:

populateDown in class SPageNode

Parameters:

parentpath - the parent significant path

widgetpathtoroot - an array of all the page nodes for traceability in case of problems

WritePayloadToCDL

public void WritePayloadToCDL(MessageWriter writer,
                              SPageData input,
                              SecurityBuffer buffer)
                       throws java.io.IOException

Description copied from class: SPageNode

writes the payload of the representation (without opening and closing structure)

Specified by:

WritePayloadToCDL in class SPageNode

Parameters:

writer - the CDL writer on which to write the message

Throws:

java.io.IOException

getWidgetCode

public java.lang.String getWidgetCode()

Specified by:

getWidgetCode in class SPageNode

hideComponent

public boolean hideComponent(SPageData input,
                             SecurityBuffer buffer)

Description copied from class: SPageNode

This method allows to hide component in a layout if the user is not authorized

Specified by:

hideComponent in class SPageNode

Returns:

true if the component should be hidden, false is the component is to be shown