Class SpacerFieldFactory

  • All Implemented Interfaces:

    public class SpacerFieldFactory
    extends FieldFactory
    Generates Spacer Fields.

    This field is not meant to be loaded by the ClassSearcher, hence the X in the name.

    • Constructor Detail

      • SpacerFieldFactory

        public SpacerFieldFactory()
      • SpacerFieldFactory

        public SpacerFieldFactory​(java.lang.String text,
                                  FieldFormatModel model,
                                  HighlightProvider hsProvider,
                                  Options displayOptions,
                                  Options fieldOptions)
        text - The text to display in the field.
        model - The Field model that will use this Address factory.
        hsProvider - the HightLightProvider.
        displayOptions - the Options for display properties.
        fieldOptions - the Options for field specific properties.
    • Method Detail

      • setText

        public void setText​(java.lang.String text)
        Sets the text for the spacer field
        text - the text to display in the listing
      • setText

        public void setText()
        Sets the literal text to display in this field.
      • getText

        public java.lang.String getText()
        Returns the spacer field's text
      • getField

        public ListingField getField​(ProxyObj<?> proxy,
                                     int varWidth)
        Description copied from class: FieldFactory
        Generates a Field based on the given information.
        Specified by:
        getField in class FieldFactory
        proxy - The object that the generated field will report some information about.
        varWidth - the additional distance along the x axis to place the generated field.
        the newly generated FactoryField that shows some property or information about the given object.
      • getFieldText

        public java.lang.String getFieldText()
        Description copied from class: FieldFactory
        Returns a description of the fields generated by this factory.
        getFieldText in class FieldFactory
      • getFieldLocation

        public FieldLocation getFieldLocation​(ListingField bf,
                                              java.math.BigInteger index,
                                              int fieldNum,
                                              ProgramLocation programLoc)
        Description copied from class: FieldFactory
        Return a FieldLocation that corresponds to the given index, fieldNum, and ProgramLocation IF and ONLY IF the given programLocation is the type generated by this class's FieldFactory.getFieldLocation(ListingField, BigInteger, int, ProgramLocation). Each FieldFactory should generate and process a unique ProgramLocation class.
        Specified by:
        getFieldLocation in class FieldFactory
        bf - the ListingField at the current cursor.
        index - the line index (corresponds to an address)
        fieldNum - the index of field within the layout to try and get a FieldLocation.
        programLoc - the ProgramLocation to be converted into a FieldLocation.
      • getProgramLocation

        public ProgramLocation getProgramLocation​(int row,
                                                  int col,
                                                  ListingField bf)
        Description copied from class: FieldFactory
        Returns the Program location for the given object, row, col, and groupPath
        Specified by:
        getProgramLocation in class FieldFactory
        row - the row within this field
        col - the col on the given row within this field.
        bf - the ListingField containing the cursor.
      • getStringToHighlight

        public java.lang.String getStringToHighlight​(ListingTextField bf,
                                                     int row,
                                                     int col,
                                                     ProgramLocation loc)
        Returns the string to highlight
        bf - the ListingTextField
        row - the row in the field
        col - the column in the field
        loc - the programLocation.
      • acceptsType

        public boolean acceptsType​(int category,
                                   java.lang.Class<?> proxyObjectClass)
        Description copied from class: FieldFactory
        Used to specify which format models this field can belong to.
        Specified by:
        acceptsType in class FieldFactory
        category - the category for this field
        proxyObjectClass - the type of proxy object used by this field
        true if this class accepts the given category.
      • newInstance

        public FieldFactory newInstance​(FieldFormatModel formatModel,
                                        HighlightProvider provider,
                                        ToolOptions options,
                                        ToolOptions fieldOptions)
        Description copied from class: FieldFactory
        Returns a new instance of this FieldFactory that can be used to generate fields instead of being used as a prototype.
        Specified by:
        newInstance in class FieldFactory
        formatModel - the model that the field belongs to.
        provider - the HightLightProvider.
        options - the Options for display properties.
        fieldOptions - the Options for field specific properties.