Package com.im.ijc.core.api.views

Interface IJCWidget.DesignerHandle

  • All Superinterfaces:
    IJCWidget
    Enclosing interface:
    IJCWidget
    public static interface IJCWidget.DesignerHandle
extends IJCWidget
    Part of IJCWidget which is supposed to be used for the communication between view (and related IJC infrastructure) and the widget. It is not aimed for a direct usage by API clients.

    • Method Detail

      • getBrowseModeComponent

        javax.swing.JComponent getBrowseModeComponent()
        Returns:
        the component used in the browse mode

      • getBuildModeRenderer

        javax.swing.JComponent getBuildModeRenderer()
        Should not be called in case the DesignerHandle implements even DesignerContainerHandle.
        Returns:
        the component used in build mode

      • setViewMode

        void setViewMode​(ViewMode viewMode)
        Notifies widget that the mode of the view has changed (e.g. by user from "Design" mode to "Browse" mode). Widget is supposed to take appropriate actions, like change its content, border, etc.
        Parameters:
        viewMode - the view mode

      • isRebindable

        boolean isRebindable()
        Returns:
        bind field(s) to widget action is enabled for widgets that return true.

      • rebind

        void rebind​(DesignerHandleDescriptor newDescriptor)
        This method notifies widget that it was bound (or re-bound) to the given fields and/or that its settings have changed. Widget should respond accordingly. If the given list is empty then widget becomes unbound.
        Parameters:
        newDescriptor - fields to which widget was just bound together with the new settings; might be null in which case widget becomes unbound
        Since:
        14.10.20

      • isFocusable

        boolean isFocusable()

      • getFactoryId

        java.lang.String getFactoryId()

      • toFormsModel

        com.chemaxon.ijc.form.api.AbstractWidget toFormsModel()
        Retrieves Forms Model representation of this IJC widget.
        Returns:
        FormsModel widget
        Since:
        18.23.0

      • activate

        void activate​(com.im.df.api.friend.data.ViewDataProvider vdp)
        This method is called by an owner of a widget at the beginning of the life-cycle of the widget. E.g. when a view owning the widget was opened, widget is given an opportunity to perform initialization steps. It is called only once per widget life-cycle.
        Parameters:
        vdp - The ViewDataProvider which will serve this widget with data.
        Since:
        14.10.20

      • release

        void release()
        This method is called by an owner of a widget at the end of the life-cycle of the widget. E.g. when a view owning the widget is being closed, widget is given an opportunity to perform clean-up like unregistering listeners, etc. It is called only once per widget life-cycle.
        Since:
        6.0

      • suspend

        void suspend()
        Called when widget will be hidden in UI.
        Since:
        6.0
        See Also:
        resume()

      • resume

        void resume()
        Called when widget is about to be shown again in UI.
        Since:
        6.0
        See Also:
        suspend()