Package com.im.ijc.core.api.views

Class IJCWidgetFactoriesProvider

java.lang.Object

com.im.ijc.core.api.views.IJCWidgetFactoriesProvider

All Implemented Interfaces:

IJCWidgetFactory.Provider

public final class IJCWidgetFactoriesProvider
extends java.lang.Object
implements IJCWidgetFactory.Provider

Allows to access instances of the registered widget factories. They should be registered in IJC/FormComponents folder in layer.xml. They have two attributes - category and iconBase. The category points to IJC/FormPaletteCategories folder and defines in which part of widgets palette the widget should appear. If the category is unspecified, the factory is registered into the "Other" category.

Example of registration of widget with category:

 <filesystem>
  <folder name="IJC">
      <folder name="FormComponents">
          <file name="com-im-ijc-formview-widgets-panel-WBPanelFactory.instance">
              <attr name="iconBase" stringvalue="com/im/ijc/formview/widgets/panel/panel.png"/>
              <attr name="category" stringvalue="my-own-category"/>
          </file>
      </folder>
      <folder name="FormPaletteCategories">
          <folder name="my-own-category">
              <attr name="displayName" stringvalue="My category"/>
              <attr name="position" intvalue="500"/>
          </folder>
      </folder>
  </folder>
 </filesystem>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IJCWidgetFactoriesProvider.FactoryInfo	Description of a registered widget factory.

Method Summary

Modifier and Type	Method	Description
IJCWidgetFactory	findFactoryById(java.lang.String id)
IJCWidgetFactoriesProvider.FactoryInfo	findFactoryInfoById(java.lang.String id)
java.util.List<IJCWidgetFactoriesProvider.FactoryInfo>	getAllFactories()
static IJCWidgetFactoriesProvider	getDefault()
java.util.List<IJCWidgetFactoriesProvider.FactoryInfo>	getVisibleFactories()

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static IJCWidgetFactoriesProvider getDefault()

findFactoryInfoById

public IJCWidgetFactoriesProvider.FactoryInfo findFactoryInfoById(java.lang.String id)

findFactoryById

public IJCWidgetFactory findFactoryById(java.lang.String id)

Specified by:

findFactoryById in interface IJCWidgetFactory.Provider

Parameters:

id - a factory identifier

Returns:

factory looked up or null

getAllFactories

public java.util.List<IJCWidgetFactoriesProvider.FactoryInfo> getAllFactories()

getVisibleFactories

public java.util.List<IJCWidgetFactoriesProvider.FactoryInfo> getVisibleFactories()

Returns:

list of factories suitable for creating new widgets

Since:

14.7.28