Class AbstractPointOverlayFromReport

    • Constructor Detail

      • AbstractPointOverlayFromReport

        public AbstractPointOverlayFromReport()
    • Method Detail

      • getOwner

        public ImagePanel.PaintPanel getOwner()
        Returns the owning panel.
        Returns:
        the owner, null if none set
      • getOverlays

        protected ReportPointOverlay getOverlays()
        Returns the underlying report point overlay object.
        Returns:
        the overlay
      • setPrefix

        public void setPrefix​(String value)
        Sets the prefix to use for the objects in the report.
        Parameters:
        value - the prefix
      • getPrefix

        public String getPrefix()
        Returns the prefix to use for the objects in the report.
        Returns:
        the prefix
      • prefixTipText

        public String prefixTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setColor

        public void setColor​(Color value)
        Sets the color to use for the objects.
        Parameters:
        value - the color
      • getColor

        public Color getColor()
        Returns the color to use for the objects.
        Returns:
        the color
      • colorTipText

        public String colorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setUseColorsPerType

        public void setUseColorsPerType​(boolean value)
        Sets whether to use colors per type.
        Parameters:
        value - true if to use colors per type
      • getUseColorsPerType

        public boolean getUseColorsPerType()
        Returns whether to use colors per type.
        Returns:
        true if to use colors per type
      • useColorsPerTypeTipText

        public String useColorsPerTypeTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setTypeColorProvider

        public void setTypeColorProvider​(ColorProvider value)
        Sets the color provider to use for the types.
        Parameters:
        value - the provider
      • getTypeColorProvider

        public ColorProvider getTypeColorProvider()
        Returns the color provider to use for the types.
        Returns:
        the provider
      • typeColorProviderTipText

        public String typeColorProviderTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setTypeSuffix

        public void setTypeSuffix​(String value)
        Sets the suffix to use for the types.
        Parameters:
        value - the suffix
      • getTypeSuffix

        public String getTypeSuffix()
        Returns the suffix to use for the types.
        Returns:
        the suffix
      • typeSuffixTipText

        public String typeSuffixTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setTypeRegExp

        public void setTypeRegExp​(BaseRegExp value)
        Sets the regular expression that the types must match in order to get drawn.
        Parameters:
        value - the expression
      • getTypeRegExp

        public BaseRegExp getTypeRegExp()
        Returns the regular expression that the types must match in order to get drawn.
        Returns:
        the expression
      • typeRegExpTipText

        public String typeRegExpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setLabelFormat

        public void setLabelFormat​(String value)
        Sets the label format.
        Parameters:
        value - the label format
      • getLabelFormat

        public String getLabelFormat()
        Returns the label format.
        Returns:
        the label format
      • labelFormatTipText

        public String labelFormatTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setLabelFont

        public void setLabelFont​(Font value)
        Sets the label font.
        Parameters:
        value - the label font
      • getLabelFont

        public Font getLabelFont()
        Returns the label font.
        Returns:
        the label font
      • labelFontTipText

        public String labelFontTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultLabelAnchor

        protected ImageAnchor getDefaultLabelAnchor()
        Returns the default label anchor.
        Returns:
        the anchor
      • setLabelAnchor

        public void setLabelAnchor​(ImageAnchor value)
        Sets the anchor for the label.
        Parameters:
        value - the anchor
      • getLabelAnchor

        public ImageAnchor getLabelAnchor()
        Returns the anchor for the label.
        Returns:
        the anchor
      • labelAnchorTipText

        public String labelAnchorTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultLabelOffsetX

        protected int getDefaultLabelOffsetX()
        Returns the default label offset for X.
        Returns:
        the default
      • setLabelOffsetX

        public void setLabelOffsetX​(int value)
        Sets the X offset for the label.
        Parameters:
        value - the X offset
      • getLabelOffsetX

        public int getLabelOffsetX()
        Returns the X offset for the label.
        Returns:
        the X offset
      • labelOffsetXTipText

        public String labelOffsetXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultLabelOffsetY

        protected int getDefaultLabelOffsetY()
        Returns the default label offset for Y.
        Returns:
        the default
      • setLabelOffsetY

        public void setLabelOffsetY​(int value)
        Sets the Y offset for the label.
        Parameters:
        value - the Y offset
      • getLabelOffsetY

        public int getLabelOffsetY()
        Returns the Y offset for the label.
        Returns:
        the Y offset
      • labelOffsetYTipText

        public String labelOffsetYTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setPredefinedLabels

        public void setPredefinedLabels​(BaseString[] value)
        Sets the predefined labels.
        Parameters:
        value - the labels
      • getPredefinedLabels

        public BaseString[] getPredefinedLabels()
        Returns the predefined labels.
        Returns:
        the labels
      • predefinedLabelsTipText

        public String predefinedLabelsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setShowPointPanel

        public void setShowPointPanel​(boolean value)
        Sets whether to show the panel with the located points.
        Parameters:
        value - true if to show
      • getShowPointPanel

        public boolean getShowPointPanel()
        Returns whether to show the panel with the located points.
        Returns:
        true if to show
      • showPointPanelTipText

        public String showPointPanelTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • hasTypeColor

        public boolean hasTypeColor​(String type)
        Checks whether a color has been stored for the given object type.
        Specified by:
        hasTypeColor in interface TypeColorProvider
        Parameters:
        type - the type to check
        Returns:
        true if custom color available
      • getTypeColor

        public Color getTypeColor​(String type)
        Returns the color for the object type.
        Specified by:
        getTypeColor in interface TypeColorProvider
        Parameters:
        type - the type to get the color for
        Returns:
        the color, null if none available
      • notifyLocationsUpdatedListeners

        protected void notifyLocationsUpdatedListeners()
        Notifies all the listeners that the notifications have been updated.
      • doPaintObjects

        protected abstract void doPaintObjects​(ImagePanel.PaintPanel panel,
                                               Graphics g,
                                               List<Polygon> locations)
        Performs the actual painting of the objects.
        Parameters:
        panel - the panel this overlay is for
        g - the graphics context
        locations - the locations to paint