Interface EditPropertiesHandler

  • All Superinterfaces:
    Extension
    All Known Implementing Classes:
    EditPropertiesHandlerAdapter

    @API(type=EXTENDABLE,
         src=PUBLIC)
    public interface EditPropertiesHandler
    extends Extension
    A custom implementation to handle editing properties for an author node. For example when a user double clicks on an element tag we will invoke this extension and a specific dialog can be presented. The user can edit different facets of that element, like attributes.

    It is recommended to extend class EditPropertiesHandlerAdapter in order to be protected from any API additions that may occur in interface EditPropertiesHandler.

    Since:
    17.1
    • Method Detail

      • editProperties

        void editProperties​(AuthorNode authorNode,
                            AuthorAccess authorAccess)
        Edit the properties for the given node.
        Parameters:
        authorNode - Author node to edit the properties for.
        authorAccess - Author access.
      • canEditProperties

        boolean canEditProperties​(AuthorNode authorNode)
        Checks if it can edit the properties for a given node.
        Parameters:
        authorNode - Author node to edit the properties for.
        Returns:
        true if it can edit the properties of the node and false if the properties of this node can't be edited.