Package ro.sync.ecss.extensions.api.editor

Interface InplaceHeavyEditor

  • All Superinterfaces:
    Extension
    @API(type=EXTENDABLE,
     src=PUBLIC)
public interface InplaceHeavyEditor
extends Extension
    A form control that appears inside the author page. It differs from the classic form control by the fact that it is placed in the component hierarchy from the very beginning.
    Since:
    18.1

    • Method Detail

      • getRenderingInfo

        RendererLayoutInfo getRenderingInfo​(AuthorInplaceContext context)
        Returns the rendering layout info. This contains information about the baseline and the size in a certain context. The baseline is measured from the top of the component. Because a renderer is reused, when this call is received, the renderer must re-initialize itself from the given context.
        Parameters:
        context - The editing context.
        Returns:
        The rendering layout info.

      • getEditorComponent

        java.lang.Object getEditorComponent​(AuthorInplaceContext context,
                                    Rectangle allocation)
        Prepare and return the editor component.
        Parameters:
        context - The context where the editor will be used.
        allocation - The bounds where the form control will be presented.
        Returns:
        The component that performs the editing. For the Standalone distribution, this should be a java.awt.JComponent implementation. For the Eclipse plugin distribution, an org.eclipse.swt.widgets.Control is expected.

      • dispose

        void dispose()
        The editor was removed from the layout and it will not be used anymore. This is the time to dispose any resources allocated with it.

      • deactivate

        void deactivate()
        An event that comes when the page that presents this form control is no longer active. For example another editor was selected. For example, if a media player form control that is playing receives this event it should pause.