Class RtfDestination

    • Field Detail

      • rtfParser

        protected RtfParser rtfParser
        Parser object
      • modified

        protected boolean modified
        Is data in destination modified?
      • lastCtrlWord

        protected RtfCtrlWordData lastCtrlWord
        The last control word handled by this destination
      • listeners

        private static final java.util.List<RtfDestinationListener> listeners
        The RtfDestinationListener.
    • Constructor Detail

      • RtfDestination

        public RtfDestination()
        Constructor.
      • RtfDestination

        public RtfDestination​(RtfParser parser)
        Constructor
        Parameters:
        parser - RtfParser object.
    • Method Detail

      • setParser

        public void setParser​(RtfParser parser)
        Set the parser to use with the RtfDestination object.
        Parameters:
        parser - The RtfParser object.
      • closeDestination

        public abstract boolean closeDestination()
        Clean up when destination is closed.
        Returns:
        true if handled, false if not handled
      • handleOpeningSubGroup

        public abstract boolean handleOpeningSubGroup()
        Handle a new subgroup contained within this group
        Returns:
        true if handled, false if not handled
      • handleCloseGroup

        public abstract boolean handleCloseGroup()
        Clean up when group is closed.
        Returns:
        true if handled, false if not handled
      • handleOpenGroup

        public abstract boolean handleOpenGroup()
        Setup when group is opened.
        Returns:
        true if handled, false if not handled
      • handleCharacter

        public abstract boolean handleCharacter​(int ch)
        Handle text for this destination
        Returns:
        true if handled, false if not handled
      • handleControlWord

        public abstract boolean handleControlWord​(RtfCtrlWordData ctrlWordData)
        Handle control word for this destination
        Parameters:
        ctrlWordData - The control word and parameter information object
        Returns:
        true if handled, false if not handled
      • setToDefaults

        public abstract void setToDefaults()
        Method to set this object to the default values. Must be implemented in child class.
      • isModified

        public boolean isModified()
        Method to indicate if data in this destination has changed.
        Returns:
        true if modified, false if not modified.
      • addListener

        public boolean addListener​(RtfDestinationListener listener)
        Adds a RtfDestinationListener to the RtfDestinationMgr.
        Parameters:
        listener - the new RtfDestinationListener.
      • removeListener

        public boolean removeListener​(RtfDestinationListener listener)
        Removes a RtfDestinationListener from the RtfDestinationMgr.
        Parameters:
        listener - the RtfCtrlWordListener that has to be removed.
      • beforeCharacter

        protected int beforeCharacter​(int ch)
      • onCharacter

        protected int onCharacter​(int ch)
      • afterCharacter

        protected int afterCharacter​(int ch)
      • onOpenGroup

        protected boolean onOpenGroup()
        Returns:
        true if all goes well
      • onCloseGroup

        protected boolean onCloseGroup()
        Returns:
        true if all goes well
      • getNewTokeniserState

        public int getNewTokeniserState()