Package com.inductiveautomation.perspective.common.api

Class ComponentDescriptorImpl

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<BrowserResource> browserResources()
      Returns a set of BrowserResources, which are provided to the designer and perspective client at runtime to insure the needed items are provided in the web environment to support the component.
      java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonObject> childPositionDefaults()
      Defined default position property structure and values for children of new instances of this component.
      JsonSchema childPositionSchema()
      Used for components that are containers in order to provide a schema for the position objects of their children.
      java.lang.String defaultMetaName()
      The default meta.name value for this component.
      com.inductiveautomation.ignition.common.gson.JsonObject defaultProperties()
      Defines default property structure and values for new instances of this component.
      java.util.Collection<ComponentEventDescriptor> events()  
      static ComponentDescriptorImpl.ComponentBuilder fromJson​(com.inductiveautomation.ignition.common.gson.JsonObject json, java.lang.String versionHash)
      Builds a ComponentDescriptor, given a JsonObject that is follows the following format: // TODO
      java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonObject> getExampleChildPositionDefaults()  
      com.inductiveautomation.ignition.common.gson.JsonObject getExampleDefaultProps()  
      javax.swing.Icon getIcon()
      Return the icon that is registered along with the descriptor.
      java.lang.String id()
      The unique string that identifies this component
      java.lang.String moduleId()
      The moduleId should be a String id that matches the module that is contributing this component to the Ignition Perspective module system.
      java.lang.String paletteCategory()
      Which category this component should be listed under in the Designer's component palette.
      java.lang.String paletteDescription()
      The description should return a short description of the component, generally as a short sentence.
      java.lang.String paletteName()
      The name for this component as it will be presented in the Designer palette, stored as a LocalizedString.
      JsonSchema schema()
      Defines the shape of the component's properties structure.
      boolean showOnPalette()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Method Detail

      • moduleId

        @Nonnull
public java.lang.String moduleId()
        Description copied from interface: ComponentDescriptor
        The moduleId should be a String id that matches the module that is contributing this component to the Ignition Perspective module system.
        Specified by:
        moduleId in interface ComponentDescriptor
        Returns:
        the Ignition module ID of the module providing the component.

      • paletteDescription

        @Nonnull
public java.lang.String paletteDescription()
        Description copied from interface: ComponentDescriptor
        The description should return a short description of the component, generally as a short sentence.
        Specified by:
        paletteDescription in interface ComponentDescriptor
        Returns:
        a short sentence about what this component does

      • defaultProperties

        @Nonnull
public com.inductiveautomation.ignition.common.gson.JsonObject defaultProperties()
        Description copied from interface: ComponentDescriptor
        Defines default property structure and values for new instances of this component.
        Specified by:
        defaultProperties in interface ComponentDescriptor

      • childPositionDefaults

        public java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonObject> childPositionDefaults()
        Description copied from interface: ComponentDescriptor
        Defined default position property structure and values for children of new instances of this component.
        Specified by:
        childPositionDefaults in interface ComponentDescriptor

      • browserResources

        @Nonnull
public java.util.Set<BrowserResource> browserResources()
        Description copied from interface: ComponentDescriptor
        Returns a set of BrowserResources, which are provided to the designer and perspective client at runtime to insure the needed items are provided in the web environment to support the component. Common use cases are css files and js libraries. These resources are collected at runtime and added to the DOM prior to starting the project/view.
        Specified by:
        browserResources in interface ComponentDescriptor
        Returns:
        a set of resources that the component requires.

      • id

        @Nonnull
public java.lang.String id()
        Description copied from interface: ComponentDescriptor
        The unique string that identifies this component
        Specified by:
        id in interface ComponentDescriptor

      • paletteCategory

        @Nonnull
public java.lang.String paletteCategory()
        Description copied from interface: ComponentDescriptor
        Which category this component should be listed under in the Designer's component palette.
        Specified by:
        paletteCategory in interface ComponentDescriptor

      • showOnPalette

        public boolean showOnPalette()
        Specified by:
        showOnPalette in interface ComponentDescriptor
        Returns:
        true if the component should be displayed in the Ignition Designer's Perspective Component palette. True by default, but may be implemented to return false to remove a component from the designer palette. Useful as a means to 'soft deprecate' a component without removing it from the system entirely, insuring that projects that already use said component will continue to function, but new instances of these components will not easily be created in the designer.

      • getIcon

        @Nullable
public javax.swing.Icon getIcon()
        Description copied from interface: ComponentDescriptor
        Return the icon that is registered along with the descriptor. If an icon is not set, the default icon will be used instead.
        Specified by:
        getIcon in interface ComponentDescriptor
        Returns:
        icon used for the nav tree and component palette

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • fromJson

        public static ComponentDescriptorImpl.ComponentBuilder fromJson​(@Nonnull
                                                                com.inductiveautomation.ignition.common.gson.JsonObject json,
                                                                @Nullable
                                                                java.lang.String versionHash)
        Builds a ComponentDescriptor, given a JsonObject that is follows the following format: // TODO
        Parameters:
        json - object to build the descriptor from
        Returns:
        ComponentDescriptor populated from the given json object
        Since:
        Ignition 8.0.6