Package com.luciad.beans.swing

Class TLcdXMLCustomizerComponentBuilder

java.lang.Object
com.luciad.beans.swing.TLcdXMLCustomizerComponentBuilder
All Implemented Interfaces:
ILcdCustomizerComponentBuilder
@Deprecated public class TLcdXMLCustomizerComponentBuilder extends Object implements ILcdCustomizerComponentBuilder
Deprecated.
Use a UI builder (e.g. Swing) or binding framework instead.
This class uses an TLdBeanGuiFactory and an xml description of the gui to create a gui for the bean object set in the TLdBeanGUIFactory The creation of that gui is invoked by createGUI(). Another useful method is setBeanGUIFactory. Also in development phase, don't forget to set trace to true (or use debug="true" in description tag in xml), this will give you useful information.

The xml description is retrieved from the BeanInfo object. To add a xml description to a BeanInfo object, add the following line in the getBeanDescriptor() method of the BeanInfo object: 

descriptorToReturn.setValue(TLcdXMLCustomizerComponentBuilder.XML_FILE_NAME, "aFileNameHere.xml");
The file should be defined relative to the classpath.

  • Field Details

    • XML_FILE_NAME

      public static final String XML_FILE_NAME
      Deprecated.
      Key to point a property descriptor towards the xml file it should use. For example: 
      
 PropertyDescriptor descriptor = ...
 descriptor.setValue( TLcdXMLCustomizerComponentBuilder.XML_FILE_NAME, "aFileNameHere.xml");
      See Also:

    • XML_FILE_EXTENSION

      public static final String XML_FILE_EXTENSION
      Deprecated.
      Assumed extension of xml files describing a layout. Only used when file is not explicitly given by means of XML_FILE_NAME.
      See Also:

  • Constructor Details

    • TLcdXMLCustomizerComponentBuilder

      public TLcdXMLCustomizerComponentBuilder()
      Deprecated.
      Creates a new empty TLcdXMLCustomizerComponentBuilder object. A parser will be created at the time you use it.

  • Method Details

    • setClassTraceOn

      public static void setClassTraceOn(boolean aClassTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
      Parameters:
      aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

    • setTraceOn

      public void setTraceOn(boolean aTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
      Parameters:
      aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

    • isTraceOn

      public boolean isTraceOn()
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Returns true if tracing is enabled for this class.
      Returns:
      true if tracing is enabled for this class, false otherwise.

    • startBuilding

      public void startBuilding(Object aBean, BeanDescriptor aBeanDescriptor)
      Deprecated.
      Description copied from interface: ILcdCustomizerComponentBuilder
      Indicates that we want to start building the Component of our Customizer.
      Specified by:
      startBuilding in interface ILcdCustomizerComponentBuilder
      Parameters:
      aBean - The bean this customizer will serve for.
      aBeanDescriptor - The bean descriptor of that bean, or null if no descriptor is available.

    • buildProperty

      public void buildProperty(PropertyDescriptor aPropertyDescriptor, PropertyEditor aPropertyEditor, Component aPropertyEditorComponent)
      Deprecated.
      Description copied from interface: ILcdCustomizerComponentBuilder
      Build a property.
      Specified by:
      buildProperty in interface ILcdCustomizerComponentBuilder
      Parameters:
      aPropertyDescriptor - The PropertyDescriptor of the property to build
      aPropertyEditor - The PropertyEditor of the property to build
      aPropertyEditorComponent - The Component used to represent the property to build

    • stopBuilding

      public void stopBuilding()
      Deprecated.
      Description copied from interface: ILcdCustomizerComponentBuilder
      Indicates that building if finished. Implementations can use this method to perform cleaning tasks, remove temporary data structures, ...
      Specified by:
      stopBuilding in interface ILcdCustomizerComponentBuilder

    • getCustomizerComponent

      public Component getCustomizerComponent()
      Deprecated.
      Description copied from interface: ILcdCustomizerComponentBuilder
      Returns the Component this builder has build. Can only be used after stopBuilding() is invoked.
      Specified by:
      getCustomizerComponent in interface ILcdCustomizerComponentBuilder
      Returns:
      the Component this builder has build.

    • getHelpIDString

      public String getHelpIDString()
      Deprecated.
      Description copied from interface: ILcdCustomizerComponentBuilder
      Returns the help id string that is associated with the component getCustomizerComponent().
      Specified by:
      getHelpIDString in interface ILcdCustomizerComponentBuilder
      Returns:
      The help ID for context sensitive help for getCustomizerComponent(), or null if no such help id is available.

    • flushParsedCache

      public void flushParsedCache()
      Deprecated.
      After a call to this method, the xml source will be parsed again. The cached, parsed version is flushed.