Package mgui.interfaces.layouts

Class LayoutItem

java.lang.Object
mgui.interfaces.AbstractInterfaceObject
mgui.interfaces.layouts.LayoutItem
All Implemented Interfaces:
InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject
public abstract class LayoutItem
extends AbstractInterfaceObject
implements XMLObject
Specifies an element to be rendered in a InterfaceLayoutDocument. Specifies its own location, dimension, and attributes.
Since:
1.0
Version:
1.0
Author:
Andrew Reid

  • Nested Class Summary

    Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

    XMLObject.XMLEncoding, XMLObject.XMLType

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected AttributeList attributes  
    protected java.awt.geom.Point2D.Float location  
    protected java.awt.geom.Point2D.Float size  

    Fields inherited from class mgui.interfaces.AbstractInterfaceObject

    isDestroyed, tree_nodes

  • Constructor Summary

    Constructors
    Constructor Description
    LayoutItem()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDTD()
    Returns the Data Type Declaration (DTD) for this object's XML representation
    double getHeight()
    Returns the height of this item, in document units.
    java.lang.String getLocalName()
    Returns the local name associated with this XML object.
    java.awt.geom.Point2D getLocation()
    Returns the upper-left corner of this item, in document space.
    java.lang.String getName()
    Gets the name for this object.
    java.lang.String getShortXML​(int tab)
    Returns a short XML representation of this object.
    java.awt.geom.Point2D.Float getSize()
    Returns the size of this item, in document units.
    double getWidth()
    Returns the width of this item, in document units.
    java.lang.String getXML()
    Returns this object's XML representation as a single string.
    java.lang.String getXML​(int tab)
    Returns this object's XML representation as a single string.
    java.lang.String getXMLSchema()
    Returns the XML schema for this object's XML representation
    void handleXMLElementEnd​(java.lang.String localName)
    Handles the end of an XML element.
    void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)
    Handles the start of an XML element.
    void handleXMLString​(java.lang.String s)
    Handles a string within an XML element.
    protected void init()
    Initiates this item's attributes.
    void setHeight​(float height)
    Sets the width of this item, in document units.
    void setLocation​(java.awt.geom.Point2D.Float location)
    Sets the upper-left corner of this item, in document space.
    void setName​(java.lang.String name)
    Sets the name for this object.
    void setSize​(java.awt.geom.Point2D.Float size)
    Sets the size of this item, in document units.
    void setWidth​(float width)
    Sets the width of this item, in document units.
    void writeXML​(int tab, java.io.Writer writer)
    Writes the XML representation of this object to file.
    void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file, as XMLType.Normal.
    void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar)
    Writes the XML representation of this object to file.

    Methods inherited from class mgui.interfaces.AbstractInterfaceObject

    clean, destroy, getTreeLabel, isDestroyed, issueTreeNode, setTreeNode, updateTreeNodes

    Methods inherited from class java.lang.Object

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

  • Field Details

    • location

      protected java.awt.geom.Point2D.Float location

    • size

      protected java.awt.geom.Point2D.Float size

    • attributes

      protected AttributeList attributes

  • Constructor Details

    • LayoutItem

      public LayoutItem()

  • Method Details

    • init

      protected void init()
      Initiates this item's attributes.

    • getName

      public java.lang.String getName()
      Description copied from interface: NamedObject
      Gets the name for this object.
      Specified by:
      getName in interface NamedObject
      Overrides:
      getName in class AbstractInterfaceObject
      Returns:

    • setName

      public void setName​(java.lang.String name)
      Description copied from interface: NamedObject
      Sets the name for this object.
      Specified by:
      setName in interface NamedObject
      Overrides:
      setName in class AbstractInterfaceObject

    • getLocation

      public java.awt.geom.Point2D getLocation()
      Returns the upper-left corner of this item, in document space.
      Returns:

    • setLocation

      public void setLocation​(java.awt.geom.Point2D.Float location)
      Sets the upper-left corner of this item, in document space.
      Parameters:
      location -

    • getWidth

      public double getWidth()
      Returns the width of this item, in document units.
      Returns:

    • setWidth

      public void setWidth​(float width)
      Sets the width of this item, in document units.
      Parameters:
      width -

    • getHeight

      public double getHeight()
      Returns the height of this item, in document units.
      Returns:

    • setHeight

      public void setHeight​(float height)
      Sets the width of this item, in document units.
      Parameters:
      width -

    • getSize

      public java.awt.geom.Point2D.Float getSize()
      Returns the size of this item, in document units.
      Returns:

    • setSize

      public void setSize​(java.awt.geom.Point2D.Float size)
      Sets the size of this item, in document units.
      Parameters:
      width -

    • getDTD

      public java.lang.String getDTD()
      Description copied from interface: XMLObject
      Returns the Data Type Declaration (DTD) for this object's XML representation

      See http://en.wikipedia.org/wiki/Document_Type_Definition for a description.

      Specified by:
      getDTD in interface XMLObject
      Returns:

    • getXMLSchema

      public java.lang.String getXMLSchema()
      Description copied from interface: XMLObject
      Returns the XML schema for this object's XML representation

      See http://en.wikipedia.org/wiki/XML_schema.

      Specified by:
      getXMLSchema in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML()
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Returns:

    • getXML

      public java.lang.String getXML​(int tab)
      Description copied from interface: XMLObject
      Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.
      Specified by:
      getXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the opening XML wrapper
      Returns:

    • handleXMLElementStart

      public void handleXMLElementStart​(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles the start of an XML element.
      Specified by:
      handleXMLElementStart in interface XMLObject
      Parameters:
      localName - Local name of the element
      attributes - Set of element attributes
      type - The XMLType of this element
      Throws:
      org.xml.sax.SAXException

    • handleXMLElementEnd

      public void handleXMLElementEnd​(java.lang.String localName) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles the end of an XML element.
      Specified by:
      handleXMLElementEnd in interface XMLObject
      Parameters:
      localName - Local name of the element
      Throws:
      org.xml.sax.SAXException

    • handleXMLString

      public void handleXMLString​(java.lang.String s) throws org.xml.sax.SAXException
      Description copied from interface: XMLObject
      Handles a string within an XML element.
      Specified by:
      handleXMLString in interface XMLObject
      Parameters:
      s - String to handle
      Throws:
      org.xml.sax.SAXException

    • getLocalName

      public java.lang.String getLocalName()
      Description copied from interface: XMLObject
      Returns the local name associated with this XML object.
      Specified by:
      getLocalName in interface XMLObject
      Returns:

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, XMLOutputOptions options, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      options - XMLOutputOptions defining the write parameters
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer, ProgressUpdater progress_bar) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file, as XMLType.Normal. The default format of XMLFormat.Ascii will be used. The basic contract for this method is that it should not write a newline character at its start or end.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      progress_bar - Optional progress updater (may be null)
      Throws:
      java.io.IOException

    • writeXML

      public void writeXML​(int tab, java.io.Writer writer) throws java.io.IOException
      Description copied from interface: XMLObject
      Writes the XML representation of this object to file. The basic contract for this method is that it should not write a newline character at its start or end. The default format of XMLFormat.Ascii will be used.
      Specified by:
      writeXML in interface XMLObject
      Parameters:
      tab - The number of tabs to place before the XML text
      writer - The writer
      Throws:
      java.io.IOException

    • getShortXML

      public java.lang.String getShortXML​(int tab)
      Description copied from interface: XMLObject
      Returns a short XML representation of this object.
      Specified by:
      getShortXML in interface XMLObject
      Returns: