Package diva.gui

Interface View

  • All Known Implementing Classes:
    AbstractView, TextView

    public interface View
    View is an interface that captures the notion of a view on a document in a graphical application. Typically, there are one or more views on a particular document, or even on different parts of the document (such as discrete pages), although this is not necessarily so. Each application will typically create one or more implementations of this interface for the types of documents it can work with.
    Version:
    $Id$
    Author:
    Michael Shilman
    Pt.AcceptedRating:
    Red
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Close the view.
      void copy​(java.awt.datatransfer.Clipboard c)
      Get the currently selected objects from this view, if any, and place them on the given clipboard.
      void cut​(java.awt.datatransfer.Clipboard c)
      Remove the currently selected objects from this view, if any, and place them on the given clipboard.
      javax.swing.JComponent getComponent()
      Return the component that implements the display of this view.
      Document getDocument()
      Get the document that this view is viewing.
      java.lang.String getShortTitle()
      Get the short title of this document.
      java.lang.String getTitle()
      Get the title of this document
      void paste​(java.awt.datatransfer.Clipboard c)
      Clone the objects currently on the clipboard, if any, and place them in the given view.
    • Method Detail

      • close

        void close()
            throws java.lang.Exception
        Close the view.
        Throws:
        java.lang.Exception - If the close operation fails.
      • copy

        void copy​(java.awt.datatransfer.Clipboard c)
        Get the currently selected objects from this view, if any, and place them on the given clipboard. If the view does not support such an operation, then do nothing.
      • cut

        void cut​(java.awt.datatransfer.Clipboard c)
        Remove the currently selected objects from this view, if any, and place them on the given clipboard. If the view does not support such an operation, then do nothing.
      • getComponent

        javax.swing.JComponent getComponent()
        Return the component that implements the display of this view.
      • getDocument

        Document getDocument()
        Get the document that this view is viewing.
      • getTitle

        java.lang.String getTitle()
        Get the title of this document
      • getShortTitle

        java.lang.String getShortTitle()
        Get the short title of this document. The short title is used in situations where the regular title is likely to be too long, such as iconified windows, menus, and so on.
      • paste

        void paste​(java.awt.datatransfer.Clipboard c)
        Clone the objects currently on the clipboard, if any, and place them in the given view. If the document does not support such an operation, then do nothing. This method is responsible for copying the data.