Interface IUIBuilder

All Known Subinterfaces:
IUIBuilderFromVS<VS_COMP>
All Known Implementing Classes:
ButtonBuilder, ComboBoxBuilder, MenuItemBuilder, TextAreaBuilder, TextBuilder

public interface IUIBuilder
The base interface used for UI builders.
Author:
Christopher Mindus
  • Method Details

    • getUIBuildComponents

      UIComp[] getUIBuildComponents()
      Returns the UI components built with the builder.
    • getBuildDescription

      String getBuildDescription(IEUIContainer cnr)
      Returns the UI builder description of what it creates. This description is used in the tree (if there is a single build choice), or in the wizard page if there are many that can be chosen from to build the same component.
      Parameters:
      cnr - The container target.
      Returns:
      The description.
    • canBuild

      boolean canBuild(IEUIContainer container, IAdaptable source)
      Returns if this property container could potentially be link capable.

      This call is done many times during drag-drop and must be very fast and not cause too much garbage collection.

      Parameters:
      container - The target container.
      source - The adaptable source.
      Returns:
      true if the builder supports building with the data.
    • addSubOperations

      void addSubOperations(IEUIContainer container, IAdaptable source, Collection<UIBuilderSubOperation> subOps)
      Adds the operation node(s) for presentation in the link wizard main page. This method is called only if the builder supports the adaptable component.
      Parameters:
      container - The container.
      source - The adaptable source.
      subOps - The build sub-operations.