Package com.arbortext.epic.ui

Interface View

All Superinterfaces:
AbstractView
All Known Implementing Classes:
ViewImpl
public interface View extends AbstractView
The View interface is a subclass of AbstractView, representing a view of an associated Document. (An edit view of a document is represented as a View object.) An Editor frame Window can contain two Views. If a UIEvent is raised for a window, an event listener can use the view attribute of the UIEvent to obtain an object that implements the View interface (not just the AbstractView).
Since:
Epic 4.3

  • Method Details

    • getWindow

      Window getWindow()
      The Window in which this view resides.

    • getOptionNames

      StringList getOptionNames()
      A StringList containing the names of all view-scope Arbortext set options.

    • getAclId

      int getAclId()
      An integer constant uniquely identifying the view. This is the value that is returned by the ACL function current_window if the view is active.

    • getForegroundColor

      String getForegroundColor()
      The foreground color of the View.
      Throws:
      WindowException - INVALID_COLOR_ERR: Raised if the DOMString is an unsupported color name or an invalid RGB specification.

    • setForegroundColor

      void setForegroundColor(String foregroundColor) throws WindowException
      The foreground color of the View.
      Throws:
      WindowException - INVALID_COLOR_ERR: Raised if the DOMString is an unsupported color name or an invalid RGB specification.

    • getBackgroundColor

      String getBackgroundColor()
      The background color of the View.
      Throws:
      WindowException - INVALID_COLOR_ERR: Raised if the DOMString is an unsupported color name or an invalid RGB specification.

    • setBackgroundColor

      void setBackgroundColor(String backgroundColor) throws WindowException
      The background color of the View.
      Throws:
      WindowException - INVALID_COLOR_ERR: Raised if the DOMString is an unsupported color name or an invalid RGB specification.

    • getSuspendUpdate

      boolean getSuspendUpdate()
      A boolean value showing whether the view should be updated when the document is modified. Typically used when an application programmer needs to modify a large portion of the document and does not want the view to be updated until all changes have been made.
      If the value is set to true, the view is not updated when the document is modified. If the value is set to false, normal updates are restored, and all changes to the document will be immediately reflected in the corresponding view. If the view is an edit view, this value only affects the modifications happened within the same script this value is set, and all edit views of the same document are affected. When the script finishes executing, the views will be updated. If the view is a dialog view, the value only affects the view it is set to, and the value affects the view until it is set to a different value .

    • setSuspendUpdate

      void setSuspendUpdate(boolean suspendUpdate)
      A boolean value showing whether the view should be updated when the document is modified. Typically used when an application programmer needs to modify a large portion of the document and does not want the view to be updated until all changes have been made.
      If the value is set to true, the view is not updated when the document is modified. If the value is set to false, normal updates are restored, and all changes to the document will be immediately reflected in the corresponding view. If the view is an edit view, this value only affects the modifications happened within the same script this value is set, and all edit views of the same document are affected. When the script finishes executing, the views will be updated. If the view is a dialog view, the value only affects the view it is set to, and the value affects the view until it is set to a different value .

    • getOption

      String getOption(String name)
      This method returns the value of the Arbortext set option, scoped to this view.
      Parameters:
      name - Specifies the option name, which must be a view-scope option.
      Returns:
      The string value of the option, or null if name is not a valid option name. Boolean values return on or off.

    • setOption

      void setOption(String name, String value) throws AOMException
      Sets the value of the Arbortext set option, scoped to this view.
      Parameters:
      name - Specifies the option name, which must be a view-scope option.
      value - Specifies the new value of the option. Boolean values are specified using the strings on or off .
      Throws:
      AOMException - Raised if the method detects an error (for example, if name is not a valid view-scope option).