Class AbstractScriptSearchProvider<T>

    • Constructor Detail

      • AbstractScriptSearchProvider

        public AbstractScriptSearchProvider​(DesignerContext context,
                                            java.lang.String name,
                                            ResourceType resourceType,
                                            java.lang.Runnable locateFunc)
    • Method Detail

      • getLogger

        protected org.apache.log4j.Logger getLogger()
      • getTargetObject

        protected T getTargetObject()
      • getCategories

        public java.util.List<java.lang.Object> getCategories()
        Description copied from interface: SearchProvider
        Returns a list of "categories", or sub-selectable units, supported by this search provider. The actual objects will be passed back in to retrieveSearchableObjects when the search is executed.
      • getName

        public java.lang.String getName()
        Description copied from interface: SearchProvider
        Returns the name of the search provider, which will be used in the gateway and a UI to uniquely identify the provider. It is expected to be in the current session's language.
      • getSelectableObjectBaseKey

        public java.lang.String getSelectableObjectBaseKey()
        Description copied from class: AbstractSearchProvider
        Returns a key that will be used with BundleUtil to get various descriptions of the selectable objects. It is expected that the following keys exist:
        '{Key}.One' - "%d object"
        '{Key}.Many' - "%d objects"
        '{Key}.Default' - what will be searched if no objects are selected. For example, "All groups" or "Default provider"
        Specified by:
        getSelectableObjectBaseKey in class AbstractSearchProvider
        Returns:
        a BundleUtil key corresponding to a description for a selectable object.
      • hasSelectableObjects

        public boolean hasSelectableObjects()
        Description copied from interface: SearchProvider
        Whether or not the set of objects searched by this provider is selectable- for examples, which groups or windows are to be searched.
      • selectObjects

        public void selectObjects​(SearchProvider.SelectedObjectsHandler handler)
        Description copied from interface: SearchProvider
        Instructs the SearchProvider to show a dialog in order to select the objects to search. The object are returned through the passed in handler, and will later be passed into executeSearch.
      • loadTargetObject

        protected void loadTargetObject()
      • saveResource

        protected void saveResource()
      • showEditorWindow

        protected void showEditorWindow()