Package se.conciliate.extensions.type

Interface SymbolType

All Superinterfaces:
Type
public interface SymbolType extends Type
Encapsulates a symbol type.

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getDescription()
    Returns an optional description for the type.
    SymbolType
    getGroupParent()
    Returns the group parent of this SymbolType.
    default List<ModelType>
    getPreferredBreakdownTypes()
     
    List<SymbolVariant>
    getVariants()
    This method should return the different variants of the symbol type.

    NOTE: These variants are only different appearances of the same symbol type, it will not be possible to create lists or in any other way filter symbols based on their variants.

    NOTE: This method may not return null, nor an empty list.

    Methods inherited from interface se.conciliate.extensions.type.Type

    definedBy, getID, getName, getName

  • Method Details

    • getGroupParent

      SymbolType getGroupParent()
      Returns the group parent of this SymbolType. The parent is used to group SymbolTypes in the UI and has nothing to do with inheritance.
      All SymbolTypes that return the same SymbolType as group parent will be grouped together in the UI. If a SymbolType should be grouped alone it should return itself as the parent.
      Returns:
      The group parent for this SymbolType.

    • getVariants

      List<SymbolVariant> getVariants()
      This method should return the different variants of the symbol type.

      NOTE: These variants are only different appearances of the same symbol type, it will not be possible to create lists or in any other way filter symbols based on their variants.

      NOTE: This method may not return null, nor an empty list. If this SymbolType only has one look, return for example a variant having the same ID and name as the symbol type. EXAMPLE: A plugin defines the symbol type "individual". These individuals could be drawn either as men or women, but should otherwise be considered equal. The plugin then registers only one symbol type, where getVariants returns variants with the identifiers "man" and "woman". These variants will at some point in time when the framework need to display them, be sent as arguments to getDrawableIcon. It is not guaranteed that the order of the calls to getDrawableIcon is the same as the order of the variants returned as a list from this method.

      Returns:
      A list of identifiers for the different looks of this symbol type.
      Since:
      3.2

    • getDescription

      default Optional<String> getDescription()
      Returns an optional description for the type. If present it should describe the purpose and usage of the symbol type.
      Returns:
      An optional description. The description can be formatted as html but should not include the start and end <html> tags. Any line-breaks will be automatically converted to
      tags.

    • getPreferredBreakdownTypes

      default List<ModelType> getPreferredBreakdownTypes()