com.esri.aims.mtier.model.arcmap
Class Layout

java.lang.Object
  |
  +--com.esri.aims.mtier.model.arcmap.Layout
All Implemented Interfaces:
Serializable

public class Layout
extends Object
implements Serializable

The Layout object represent a Layout from an ArcMap Service.

See Also:
Serialized Form

Constructor Summary
Layout()
          Constructs an instance of a Layout object.
 
Method Summary
 long getDPI()
          Returns the DPI(dots per square inch) for the output image.
 FeatureCoordSys getFeatureCoordSys()
          Returns the Layout objects associated FeatureCoordSys object.
 FilterCoordSys getFilterCoordSys()
          Returns the Layout objects associated FilterCoordSys object.
 long getImageHeight()
          Returns the Layout objects image height property value.
 long getImageWidth()
          Returns the Layout objects image width property value.
 Envelope getLayoutEnvelope()
          Returns the Layout objects associated envelope object.
 LayoutOutput getLayoutOutput()
          Returns the layout objects associated LayoutOutput object.
 String getPageUnits()
          Returns the Layout objects page units value.
 void setDPI(long value)
          Sets the DPI(dots per square inch) for the output image.
 void setFeatureCoordSys(FeatureCoordSys obj)
          Sets the Layout objects associated FeatureCoordSys object.
 void setFilterCoordSys(FilterCoordSys obj)
          Sets the Layout objects associated FilterCoordSys object.
 void setImageHeight(long value)
          Sets the Layout objects image height property.
 void setImageWidth(long value)
          Sets the Layout objects image width property.
 void setLayoutEnvelope(Envelope obj)
          Sets the Layout objects associated envelope object.
 void setLayoutOutput(LayoutOutput obj)
          Sets the Layout objects LayoutOutput object.
 void setPageUnits(String value)
          Sets the page units for the Layout object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Layout

public Layout()
Constructs an instance of a Layout object.

Layout layout = new Layout();

Method Detail

setLayoutEnvelope

public void setLayoutEnvelope(Envelope obj)
Sets the Layout objects associated envelope object. The Layout envelopes values are in page units.

 Envelope env = new Envelope();
 env.setMinX(0.0);
 env.setMinY(0.0);
 env.setMaxX(8.0);
 env.setMaxY(4.5);
 layout.setLayoutEnvelope(env);
 

Parameters:
obj - the Envelope object.
See Also:
getLayoutEnvelope()

getLayoutEnvelope

public Envelope getLayoutEnvelope()
Returns the Layout objects associated envelope object.

 double minx = layout.getLayoutEnvelope().getMinX();
 

Returns:
Envelope
See Also:
setLayoutEnvelope(com.esri.aims.mtier.model.envelope.Envelope)

setPageUnits

public void setPageUnits(String value)
Sets the page units for the Layout object.

 layout.setPageUnits("inches");
 

See Also:
getPageUnits()

getPageUnits

public String getPageUnits()
Returns the Layout objects page units value.

  String units = layout.getPageUnits();
  

Returns:
String
See Also:
setPageUnits(java.lang.String)

setFeatureCoordSys

public void setFeatureCoordSys(FeatureCoordSys obj)
Sets the Layout objects associated FeatureCoordSys object.

Parameters:
obj - the FeatureCoordSys object.
See Also:
getFeatureCoordSys()

getFeatureCoordSys

public FeatureCoordSys getFeatureCoordSys()
Returns the Layout objects associated FeatureCoordSys object.

Returns:
FeatureCoordSys
See Also:
setFeatureCoordSys(com.esri.aims.mtier.model.map.projection.FeatureCoordSys)

setFilterCoordSys

public void setFilterCoordSys(FilterCoordSys obj)
Sets the Layout objects associated FilterCoordSys object.

Parameters:
obj - the FilterCoordSys object.
See Also:
getFilterCoordSys()

getFilterCoordSys

public FilterCoordSys getFilterCoordSys()
Returns the Layout objects associated FilterCoordSys object.

Returns:
FilterCoordSys;
See Also:
setFilterCoordSys(com.esri.aims.mtier.model.map.projection.FilterCoordSys)

setImageWidth

public void setImageWidth(long value)
Sets the Layout objects image width property. The layout image width gets generated at the set width.

  layout.setImageWidth(10);
 

Parameters:
value - the width value.
See Also:
getImageWidth()

getImageWidth

public long getImageWidth()
Returns the Layout objects image width property value.

  long width = layout.getImageWidth();
 

Returns:
long
See Also:
setImageWidth(long)

setImageHeight

public void setImageHeight(long value)
Sets the Layout objects image height property. The layout image height gets generated at the set height.

  layout.setImageHeight(10);
 

Parameters:
value - the height value.
See Also:
getImageHeight()

getImageHeight

public long getImageHeight()
Returns the Layout objects image height property value.

  long height = layout.getImageHeight();
 

Returns:
long
See Also:
setImageHeight(long)

setDPI

public void setDPI(long value)
Sets the DPI(dots per square inch) for the output image. Example:
map.setDPI(200);

Parameters:
value - the DPI value.
See Also:
getDPI()

getDPI

public long getDPI()
Returns the DPI(dots per square inch) for the output image. Example:
long dpi = map.getDPI();

Returns:
long
See Also:
setDPI(long)

setLayoutOutput

public void setLayoutOutput(LayoutOutput obj)
Sets the Layout objects LayoutOutput object. The LayoutOutput object contains parameters for image creation, and the URL and file location of the generated image.

  LayoutOutput output = new LayoutOutput();
    layout.setLayoutOutput(output);
 

Parameters:
obj - the LayoutOutput object.
See Also:
getLayoutOutput()

getLayoutOutput

public LayoutOutput getLayoutOutput()
Returns the layout objects associated LayoutOutput object.

Returns:
LayoutOutput
See Also:
#getLayoutOuput