Class HistoryBrowserInterface

java.lang.Object
org.apache.batik.apps.svgbrowser.HistoryBrowserInterface

public class HistoryBrowserInterface extends Object
The wrapper for the history browser. The commands for the historyBrowser are implemented here
  • Field Details

    • historyBrowser

      protected HistoryBrowser historyBrowser
      The history browser.
    • currentCompoundCommand

      protected AbstractCompoundCommand currentCompoundCommand
      Used to group custom number of changes into a single command.
  • Constructor Details

  • Method Details

    • setCommmandController

      public void setCommmandController(HistoryBrowser.CommandController newCommandController)
      Sets the history browser's command controller.
      Parameters:
      newCommandController - The commandController to set
    • createCompoundUpdateCommand

      public HistoryBrowserInterface.CompoundUpdateCommand createCompoundUpdateCommand(String commandName)
      Creates the compound update command, that consists of custom number of commands.
      Parameters:
      commandName - Compound command name
      Returns:
      CompoundUpdateCommand
    • createNodeChangedCommand

      public HistoryBrowserInterface.CompoundUpdateCommand createNodeChangedCommand(Node node)
      Creates the compound NodeChangedCommand. Used to create the 'dynamic' NodeChangedCommand name
      Returns:
      the CompoundUpdateCommand
    • createNodesDroppedCommand

      public HistoryBrowserInterface.CompoundUpdateCommand createNodesDroppedCommand(ArrayList nodes)
      Creates the compound NodesDroppedCommand. Used to create the 'dynamic' NodesDroppedCommand name
      Parameters:
      nodes - The list of the nodes that are being dropped
      Returns:
      the CompoundUpdateCommand
    • createRemoveSelectedTreeNodesCommand

      public HistoryBrowserInterface.CompoundUpdateCommand createRemoveSelectedTreeNodesCommand(ArrayList nodes)
      Creates the compound RemoveSelectedTreeNodesCommand. Used to create the 'dynamic' RemoveSelectedTreeNodesCommand name
      Parameters:
      nodes - The list of the nodes that are selected and should be removed
      Returns:
      the RemoveSelectedTreeNodesCommand
    • performCompoundUpdateCommand

      public void performCompoundUpdateCommand(UndoableCommand command)
      Executes the given compound update command.
      Parameters:
      command - The given compound update command
    • getHistoryBrowser

      public HistoryBrowser getHistoryBrowser()
      Gets the history browser.
      Returns:
      the historyBrowser
    • nodeInserted

      public void nodeInserted(Node newParent, Node newSibling, Node contextNode)
      Adds the NodeInsertedCommand to historyBrowser.
      Parameters:
      newParent - New parent node
      newSibling - New (next) sibling node
      contextNode - The node to be appended
    • createNodeInsertedCommand

      public HistoryBrowserInterface.NodeInsertedCommand createNodeInsertedCommand(Node newParent, Node newSibling, Node contextNode)
      Creates the NodeInserted command.
      Parameters:
      newParent - New parent node
      newSibling - New (next) sibling node
      contextNode - The node to be appended
    • nodeRemoved

      public void nodeRemoved(Node oldParent, Node oldSibling, Node contextNode)
      Adds the NodeRemovedCommand to historyBrowser.
      Parameters:
      oldParent - The node's old parent
      oldSibling - The node's old next sibling
      contextNode - The node to be removed
    • createNodeRemovedCommand

      public HistoryBrowserInterface.NodeRemovedCommand createNodeRemovedCommand(Node oldParent, Node oldSibling, Node contextNode)
      Creates the NodeRemoved command.
      Parameters:
      oldParent - The node's old parent
      oldSibling - The node's old next sibling
      contextNode - The node to be removed
    • attributeAdded

      public void attributeAdded(Element contextElement, String attributeName, String newAttributeValue, String namespaceURI)
      Adds the AttributeAddedCommand to historyBrowser.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      newAttributeValue - The attribute value
      namespaceURI - The namespaceURI
    • createAttributeAddedCommand

      public HistoryBrowserInterface.AttributeAddedCommand createAttributeAddedCommand(Element contextElement, String attributeName, String newAttributeValue, String namespaceURI)
      Creates the AttributeAdded command.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      newAttributeValue - The attribute value
      namespaceURI - The namespaceURI
    • attributeRemoved

      public void attributeRemoved(Element contextElement, String attributeName, String prevAttributeValue, String namespaceURI)
      Adds the AttributeRemovedCommand to historyBrowser.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      prevAttributeValue - The previous attribute value
      namespaceURI - The namespaceURI
    • createAttributeRemovedCommand

      public HistoryBrowserInterface.AttributeRemovedCommand createAttributeRemovedCommand(Element contextElement, String attributeName, String prevAttributeValue, String namespaceURI)
      Creates the AttributeRemoved command.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      prevAttributeValue - The previous attribute value
      namespaceURI - The namespaceURI
    • attributeModified

      public void attributeModified(Element contextElement, String attributeName, String prevAttributeValue, String newAttributeValue, String namespaceURI)
      Adds the AttributeModifiedCommand to historyBrowser.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      prevAttributeValue - The previous attribute value
      newAttributeValue - The new attribute value
      namespaceURI - The namespaceURI
    • createAttributeModifiedCommand

      public HistoryBrowserInterface.AttributeModifiedCommand createAttributeModifiedCommand(Element contextElement, String attributeName, String prevAttributeValue, String newAttributeValue, String namespaceURI)
      Creates the AttributeModified command.
      Parameters:
      contextElement - The context element
      attributeName - The attribute name
      prevAttributeValue - The previous attribute value
      newAttributeValue - The new attribute value
      namespaceURI - The namespaceURI
    • charDataModified

      public void charDataModified(Node contextNode, String oldValue, String newValue)
      Adds CharDataModifiedCommand to historyBrowser.
      Parameters:
      contextNode - The node whose nodeValue changed
      oldValue - The old node value
      newValue - The new node value
    • createCharDataModifiedCommand

      public HistoryBrowserInterface.CharDataModifiedCommand createCharDataModifiedCommand(Node contextNode, String oldValue, String newValue)
      Creates the CharDataModified command.
      Parameters:
      contextNode - The node whose nodeValue changed
      oldValue - The old node value
      newValue - The new node value
    • appendChild

      public void appendChild(Node parent, Node child)
      Adds and executes the AppendChildCommand to historyBrowser.
      Parameters:
      parent - The given parent
      child - The node to be appended
    • createAppendChildCommand

      public HistoryBrowserInterface.AppendChildCommand createAppendChildCommand(Node parent, Node child)
      Creates and return the AppendChild command.
      Parameters:
      parent - The given parent
      child - The node to be appended
      Returns:
      the AppendChild command
    • insertChildBefore

      public void insertChildBefore(Node parent, Node sibling, Node child)
      Adds and executes the InsertNodeBeforeCommand to historyBrowser.
      Parameters:
      parent - The given parent
      sibling - Points where to be inserted
      child - The node to insert
    • createInsertChildCommand

      public UndoableCommand createInsertChildCommand(Node parent, Node sibling, Node child)
      Creates InsertChildBefore or AppendChild command, depending on the value of siblingNode.
      Parameters:
      parent - The parent node
      sibling - The sibling node
      child - The child node
      Returns:
      AppendChild command if sibling node is null, InsertChildBefore otherwise
    • createInsertNodeBeforeCommand

      public HistoryBrowserInterface.InsertNodeBeforeCommand createInsertNodeBeforeCommand(Node parent, Node sibling, Node child)
      Creates and returns the InsertNodeBeforeCommand.
      Parameters:
      parent - The given parent
      sibling - Points where to be inserted
      child - The node to insert
      Returns:
      the InsertNodeBeforeCommand
    • replaceChild

      public void replaceChild(Node parent, Node newChild, Node oldChild)
      Adds and executes the ReplaceChild command to historyBrowser.
      Parameters:
      parent - The parent node
      newChild - Points where to be inserted
      oldChild - The node to be appended
    • removeChild

      public void removeChild(Node parent, Node child)
      Adds and executes the RemoveChild command to the History Browser.
      Parameters:
      parent - The given parent
      child - The given child
    • createRemoveChildCommand

      public HistoryBrowserInterface.RemoveChildCommand createRemoveChildCommand(Node parent, Node child)
      Creates and returns the RemoveChild command.
      Parameters:
      parent - The parent node
      child - The child node
      Returns:
      The RemoveChild command
    • setNodeValue

      public void setNodeValue(Node contextNode, String newValue)
      Adds and executes the ChangeNodeValueCommand to historyBrowser.
      Parameters:
      contextNode - The node whose nodeValue changed
      newValue - The new node value
    • createChangeNodeValueCommand

      public HistoryBrowserInterface.ChangeNodeValueCommand createChangeNodeValueCommand(Node contextNode, String newValue)
      Creates and returns the ChangeNodeValue command.
      Parameters:
      contextNode - The node whose nodeValue changed
      newValue - The new node value
      Returns:
      the ChangeNodeValue command
    • getCurrentCompoundCommand

      public AbstractCompoundCommand getCurrentCompoundCommand()
      Gets the current compound command.
      Returns:
      the currentCompoundCommand
    • addToCurrentCompoundCommand

      public void addToCurrentCompoundCommand(AbstractUndoableCommand cmd)
      Adds the given command to current compound command.
      Parameters:
      cmd - The command to add
    • performCurrentCompoundCommand

      public void performCurrentCompoundCommand()
      Adds and executes the current compound command to history browser.