Package net.sf.gridarta.action.exportmap

Class LayoutInfo

  • public class LayoutInfo
extends java.lang.Object
    Stores layout information for maps.

    • Constructor Summary

      Constructors 
      Constructor Description
      LayoutInfo​(@NotNull MapFile mapFile, int x, int y)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NotNull MapFile getMapFile()
      Returns the MapFile that identifies the map.
      int getX()
      Returns the x coordinate of the left border of the map within the final image.
      int getY()
      Returns the y coordinate of the top border of the map within the final image.
      @NotNull java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LayoutInfo

        public LayoutInfo​(@NotNull
                  @NotNull MapFile mapFile,
                  int x,
                  int y)
        Creates a new instance.
        Parameters:
        mapFile - the map file that identifies the map
        x - the x coordinate of the left border of the map within the final image; may be negative
        y - the y coordinate of the top border of the map within the final image; may be negative

    • Method Detail

      • getMapFile

        @NotNull
public @NotNull MapFile getMapFile()
        Returns the MapFile that identifies the map.
        Returns:
        the map file

      • getX

        public int getX()
        Returns the x coordinate of the left border of the map within the final image. The origin of the final image is an arbitrary point, therefore this x coordinate may be negative.
        Returns:
        the x coordinate; may be negative

      • getY

        public int getY()
        Returns the y coordinate of the top border of the map within the final image. The origin of the final image is an arbitrary point, therefore this y coordinate may be negative.
        Returns:
        the y coordinate; may be negative

      • toString

        @NotNull
public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object