org.openlowcode.server.graphic.widget

Class SFieldSearcher<E extends DataObject<E> & UniqueidentifiedInterface<E>>

java.lang.Object

org.openlowcode.server.graphic.SPageNode

org.openlowcode.server.graphic.widget.SFieldSearcher<E>

Type Parameters:

E - type of data object being searched

All Implemented Interfaces:

SDefaultPath

public class SFieldSearcher<E extends DataObject<E> & UniqueidentifiedInterface<E>>
extends SPageNode
implements SDefaultPath

A searcher widget that typically allows to enter number and have a list of objects in a popup to choose from. This is often used with the SObjectArrayField widget (for example to show links to objects in a compact way)

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
SFieldSearcher(java.lang.String name, java.lang.String addlabel, java.lang.String closelabel, java.lang.String rollovertip, SInlineActionRef search, SActionRef action, DataObjectDefinition<E> objectmodel, DataObjectFieldMarker<E> fieldtoshow, SPage parent)
SFieldSearcher(java.lang.String name, java.lang.String addlabel, java.lang.String closelabel, java.lang.String rollovertip, SInlineActionRef search, SInlineActionRef inlineaction, DataObjectDefinition<E> objectmodel, DataObjectFieldMarker<E> fieldtoshow, SPage parent)

Method Summary

Modifier and Type	Method and Description
void	addBottomAction(SActionRef actionatbottom, java.lang.String bottomactionlabel, boolean showonlyifemptysearch) The action at bottom displays after the search button is pressed.
SActionDataLoc<TObjectDataEltType<E>>	getObject(SActionInputDataRef<TObjectDataEltType<E>> objectargument)
java.util.function.Function<SActionInputDataRef<ArrayDataEltType<TObjectIdDataEltType<E>>>,SActionDataLoc<ArrayDataEltType<TObjectIdDataEltType<E>>>>	getObjectIdArrayInput() gets the data object id of the object selected in the searcher, to be used in the action as a one element array
java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>>	getObjectIdInput() gets the data object id of the object selected by the searcher to be used in the action
java.util.function.Function<SActionInputDataRef<TObjectDataEltType<E>>,SActionDataLoc<TObjectDataEltType<E>>>	getObjectInput() gets the full data object of the object selected in the searcher, to be used in the action
java.lang.String	getPathName()
java.util.function.Function<SActionInputDataRef<TextDataEltType>,SActionDataLoc<TextDataEltType>>	getSearchTextInput() gets the text entered in the search widget as action attribute
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	setSearchInlineOutput(SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineoutputdata) sets the result of the search inside the widget
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

SFieldSearcher

public SFieldSearcher(java.lang.String name,
                      java.lang.String addlabel,
                      java.lang.String closelabel,
                      java.lang.String rollovertip,
                      SInlineActionRef search,
                      SActionRef action,
                      DataObjectDefinition<E> objectmodel,
                      DataObjectFieldMarker<E> fieldtoshow,
                      SPage parent)

Parameters:

name - name of the widget (should be unique in parent widget with a significant path)

addlabel - label showing on the button

closelabel - label when the field is closed (for example 'add' to explain people should add a new reference to link here)

rollovertip - tip that will show on the button

search - action launched for search. This action should have one string argument and gives back an array of objects

action - action to trigger after the searched object has been selected

objectmodel - definition of the data object

fieldtoshow - field to show in searcher. Typically, this is the object number

parent - parent page

SFieldSearcher

public SFieldSearcher(java.lang.String name,
                      java.lang.String addlabel,
                      java.lang.String closelabel,
                      java.lang.String rollovertip,
                      SInlineActionRef search,
                      SInlineActionRef inlineaction,
                      DataObjectDefinition<E> objectmodel,
                      DataObjectFieldMarker<E> fieldtoshow,
                      SPage parent)

Parameters:

name - name of the widget (should be unique in parent widget with a significant path)

addlabel - label showing on the button

closelabel - label when the field is closed (for example 'add' to explain people should add a new reference to link here)

rollovertip - tip that will show on the button

search - action launched for search. This action should have one string argument and gives back an array of objects

inlineaction - inline action triggered when object is selected

objectmodel - definition of the data object shown in this widget

fieldtoshow - field to show (typically the number)

parent - parent page for the widget

Method Detail

addBottomAction

public void addBottomAction(SActionRef actionatbottom,
                            java.lang.String bottomactionlabel,
                            boolean showonlyifemptysearch)

The action at bottom displays after the search button is pressed. It typically allows to create an object if no one is found.

Parameters:

actionatbottom -

bottomactionlabel -

showonlyifemptysearch -

getObjectIdInput

public java.util.function.Function<SActionInputDataRef<TObjectIdDataEltType<E>>,SActionDataLoc<TObjectIdDataEltType<E>>> getObjectIdInput()

gets the data object id of the object selected by the searcher to be used in the action

Returns:

data object id of the object selected

getObject

public SActionDataLoc<TObjectDataEltType<E>> getObject(SActionInputDataRef<TObjectDataEltType<E>> objectargument)

getObjectInput

public java.util.function.Function<SActionInputDataRef<TObjectDataEltType<E>>,SActionDataLoc<TObjectDataEltType<E>>> getObjectInput()

gets the full data object of the object selected in the searcher, to be used in the action

Returns:

reference to the data object

getObjectIdArrayInput

public java.util.function.Function<SActionInputDataRef<ArrayDataEltType<TObjectIdDataEltType<E>>>,SActionDataLoc<ArrayDataEltType<TObjectIdDataEltType<E>>>> getObjectIdArrayInput()

gets the data object id of the object selected in the searcher, to be used in the action as a one element array

Returns:

a reference to a one element object id array

getSearchTextInput

public java.util.function.Function<SActionInputDataRef<TextDataEltType>,SActionDataLoc<TextDataEltType>> getSearchTextInput()

gets the text entered in the search widget as action attribute

Returns:

reference to the text entered in the search widget

setSearchInlineOutput

public void setSearchInlineOutput(SActionOutputDataRef<ArrayDataEltType<TObjectDataEltType<E>>> inlineoutputdata)

sets the result of the search inside the widget

Parameters:

inlineoutputdata - result of the search (array of objects)

getPathName

public java.lang.String getPathName()

Specified by:

getPathName in interface SDefaultPath

Returns:

the path for this element

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