Interface ReferenceEditorLogic<T>
-
- All Known Implementing Classes:
AbstractReferenceEditor,DefaultEnumMultiReferenceEditor,DefaultExtendedMultiReferenceEditor,DefaultFixedReferenceEditor,DefaultMultiReferenceEditor,DefaultReferenceEditor
public interface ReferenceEditorLogic<T>Common interface forDefaultReferenceEditorandDefaultMultiReferenceEditor, used byReferenceEditorLayout
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidaddSelectedObject(T obj)Inform editor that user select new objectbooleanallowNestedObjectCreation()Determines if nested object creation controlls should be rendered.voidcreateNewReference()Creates new object within the context.voidcreateNewReference(java.lang.String typeCode)Creates new object within the context.default voidforwardEditorEvent(java.lang.String eventCode)Forwards event to editor listener.Pageable<T>getPageable()java.lang.StringgetStringRepresentationOfObject(T obj)java.lang.StringgetTypeCode()booleanisDisableDisplayingDetails()default booleanisDisableRemoveReference()booleanisEditable()booleanisOnlyCreateMode()Determines if choosing existing item is possible.default booleanisReferenceAdvancedSearchEnabled()Tells if search button should open advanced reference search in a popup.default voidopenReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)Sends a socked event onAbstractReferenceEditor.SOCKET_OUT_REFERENCE_SEARCH_CTXdefault voidpreserveFocus()Sets focus on parent editorvoidrefreshObjects(java.util.Collection<T> objects)Informs editor to update objects in modelvoidremoveSelectedObject(T obj)Inform editor that user remove object from selected items listvoidtriggerReferenceSelected(java.lang.Object selectedReference)Triggers selected reference socktet output to outside widgetsvoidupdateReferencesListBoxModel()Perform search for all elements and refresh paging componentvoidupdateReferencesListBoxModel(java.lang.String textQuery)Perform search with given textQuery and refresh paging component
-
-
-
Method Detail
-
getStringRepresentationOfObject
java.lang.String getStringRepresentationOfObject(T obj)
- Parameters:
obj-- Returns:
- Label for given object
-
isEditable
boolean isEditable()
- Returns:
- whether editor is in editable or readonly state
-
addSelectedObject
void addSelectedObject(T obj)
Inform editor that user select new object- Parameters:
obj-
-
isDisableDisplayingDetails
boolean isDisableDisplayingDetails()
-
isDisableRemoveReference
default boolean isDisableRemoveReference()
-
createNewReference
void createNewReference()
Creates new object within the context.
-
createNewReference
void createNewReference(java.lang.String typeCode)
Creates new object within the context.
-
removeSelectedObject
void removeSelectedObject(T obj)
Inform editor that user remove object from selected items list- Parameters:
obj-
-
updateReferencesListBoxModel
void updateReferencesListBoxModel()
Perform search for all elements and refresh paging component
-
updateReferencesListBoxModel
void updateReferencesListBoxModel(java.lang.String textQuery)
Perform search with given textQuery and refresh paging component- Parameters:
textQuery-
-
allowNestedObjectCreation
boolean allowNestedObjectCreation()
Determines if nested object creation controlls should be rendered.- Returns:
-
triggerReferenceSelected
void triggerReferenceSelected(java.lang.Object selectedReference)
Triggers selected reference socktet output to outside widgets- Parameters:
selectedReference- reference currently selected
-
refreshObjects
void refreshObjects(java.util.Collection<T> objects)
Informs editor to update objects in model- Parameters:
objects-
-
getTypeCode
java.lang.String getTypeCode()
- Returns:
- code of type which instance would be created
-
isOnlyCreateMode
boolean isOnlyCreateMode()
Determines if choosing existing item is possible.- Returns:
-
forwardEditorEvent
default void forwardEditorEvent(java.lang.String eventCode)
Forwards event to editor listener.- Parameters:
eventCode- event code.
-
openReferenceAdvancedSearch
default void openReferenceAdvancedSearch(java.util.Collection<T> currentlySelected)
Sends a socked event onAbstractReferenceEditor.SOCKET_OUT_REFERENCE_SEARCH_CTX
-
isReferenceAdvancedSearchEnabled
default boolean isReferenceAdvancedSearchEnabled()
Tells if search button should open advanced reference search in a popup.
-
preserveFocus
default void preserveFocus()
Sets focus on parent editor
-
-