Package org.opensourcephysics.controls

Interface XMLControl

All Superinterfaces:
Control, XMLProperty
All Known Implementing Classes:
XMLControlElement
public interface XMLControl extends Control, XMLProperty
This defines methods for storing data in an xml control element.
Version:
1.0
Author:
Douglas Brown

  • Method Details

    • getPropertyType

      int getPropertyType(String name)
      Gets the type of the specified property.
      Parameters:
      name - the property name
      Returns:
      the type

    • getObjectClassName

      String getObjectClassName()
      Gets the name of the object class for which this element stores data.
      Returns:
      the object class name

    • getObjectClass

      Class<?> getObjectClass()
      Gets the class for which this stores data.
      Returns:
      the class

    • saveObject

      void saveObject(Object obj)
      Saves an object's data in this XMLControl.
      Parameters:
      obj - the object to save.

    • loadObject

      Object loadObject(Object obj)
      Loads an object with data from this XMLControl.
      Parameters:
      obj - the object to load
      Returns:
      the loaded object

    • read

      String read(String name)
      Reads the control from an xml document with the specified name.
      Parameters:
      name - the name
      Returns:
      the full name of the opened document or null if failed

    • read

      void read(Reader reader)
      Reads the control from a Reader.
      Parameters:
      reader - the Reader

    • readXML

      void readXML(String xml)
      Reads the control from an xml string.
      Parameters:
      xml - the xml string

    • failedToRead

      boolean failedToRead()
      Returns true if the most recent read operation failed.
      Returns:
      true if the most recent read operation failed

    • write

      String write(String fileName)
      Writes the control as an xml document with the specified name.
      Parameters:
      fileName - the file name
      Returns:
      the full name of the saved document or null if failed

    • write

      void write(Writer writer)
      Writes the control to a Writer.
      Parameters:
      writer - the Writer

    • toXML

      String toXML()
      Returns this control as an xml string.
      Returns:
      the xml string

    • getBasepath

      String getBasepath()

    • setBasepath

      void setBasepath(String basepath)

    • getPropsRaw

      List<XMLProperty> getPropsRaw()

    • loadObject

      Object loadObject(Object obj, Object data)