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

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

public class DataFramesCollection
extends Object
implements Serializable

The DataFrameCollection object contains a collection of DataFrame objects. The DataFrameCollection is populated when calling the buildDataframes method.

See Also:
Serialized Form

Constructor Summary
DataFramesCollection()
          Constructs an instance of a DataFramesCollection object.
 
Method Summary
 void addDataFrame(DataFrame obj)
          Adds DataFrame objects to the DataFramesCollection object.
 void buildDataFrames(ConnectionProxy connector, long dpi, boolean loadEnvelope, boolean loadRenderer, boolean loadRecordset, boolean loadExtensions)
          Builds a collection of DataFrames from an ArcMap service.
 void clearDataFrames()
          Clears all DataFrame objects from the DataFramesCollection object.
 void generateLayout()
          Generates a GET_LAYOUT request to an ArcMap service to generate an ArcMap layout.
 DataFrame getDataFrame(int index)
          Returns a DataFrame object from the DataFramesCollection object.
 int getDataFramesCount()
          Returns the count of DataFrame objects in the collection.
 ImageLimit getImageLimit()
          Returns the DataFramesCollection objects ImageLimit object.
 Layout getLayoutObject()
          Returns the DataFramesCollection objects associated Layout object.
 Locale getLocale()
          Returns the DataFramesCollection objects Locale object.
 String getRetrievableDataFrameName()
           
 Separators getSeparators()
          Returns the DataFramesCollection objects Separators object.
 boolean getTOC()
           
 String getTOCType()
           
 UIFont getUIFont()
          Returns the DataFramesCollection objects UIFont object.
 boolean isAutoResize()
          Returns autoresize associated with a Layout.
 boolean isLayout()
          Returns true if the specifying to generate layouts for all dataframes in collection.
 Object removeDataFrame(int index)
          Removes a DataFrame object from the collection.
 void setAutoResize(boolean value)
          Sets Layout autoresize.
 void setLayout(boolean value)
          Specifies to generate layouts for all DataFrame objects in the DataFrames collection.
 void setLayoutObject(Layout obj)
          Sets Layout object for a DataframeCollection.
 void setRetrievableDataFrameName(String value)
           
 void setTOC(boolean value)
           
 void setTOCType(String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataFramesCollection

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

DataFramesCollection dataFramesCollection = new DataFramesCollection();

Method Detail

setAutoResize

public void setAutoResize(boolean value)
Sets Layout autoresize. If autoresize is set to "true", a requested layout greater than the maximum pixel count is reduced in size to within the maximum pixel count.


isAutoResize

public boolean isAutoResize()
Returns autoresize associated with a Layout.


getImageLimit

public ImageLimit getImageLimit()
Returns the DataFramesCollection objects ImageLimit object.

 ImageLimit imageLimit = dataFramesCollection.getImageLimit();
 

Returns:
ImageLimit

getLocale

public Locale getLocale()
Returns the DataFramesCollection objects Locale object.

Locale locale = dataFramesCollection.getLocale();

Returns:
Locale

getSeparators

public Separators getSeparators()
Returns the DataFramesCollection objects Separators object.

Separators separators = dataFramesCollection.getSeparators();

Returns:
Separators

getUIFont

public UIFont getUIFont()
Returns the DataFramesCollection objects UIFont object.

 UIFont uiFont = dataFramesCollection.getUIFont();
 

Returns:
UIFont

setRetrievableDataFrameName

public void setRetrievableDataFrameName(String value)

getRetrievableDataFrameName

public String getRetrievableDataFrameName()

setTOC

public void setTOC(boolean value)

getTOC

public boolean getTOC()

setTOCType

public void setTOCType(String value)

getTOCType

public String getTOCType()

addDataFrame

public void addDataFrame(DataFrame obj)
Adds DataFrame objects to the DataFramesCollection object.

Parameters:
obj - the DataFrame object.
See Also:
removeDataFrame(int), clearDataFrames()

getDataFramesCount

public int getDataFramesCount()
Returns the count of DataFrame objects in the collection.

 int count = dataFramesCollection.getDataFramesCount();
 

Returns:
int

removeDataFrame

public Object removeDataFrame(int index)
Removes a DataFrame object from the collection.

 dataFramesCollection.removeDataFrame(1);
 

Parameters:
index - the DataFrame object to remove
Returns:
Object
See Also:
#AddDataFrame

clearDataFrames

public void clearDataFrames()
Clears all DataFrame objects from the DataFramesCollection object.

 dataFramesCollection.clearDataFrames();
 

See Also:
addDataFrame(com.esri.aims.mtier.model.arcmap.DataFrame)

getDataFrame

public DataFrame getDataFrame(int index)
Returns a DataFrame object from the DataFramesCollection object.

 DataFrame dataFrame = dataFramesCollection.getDataFrame(1);
 

Parameters:
index - the DataFrame object to return.
Returns:
DataFrame

setLayout

public void setLayout(boolean value)
Specifies to generate layouts for all DataFrame objects in the DataFrames collection.

  dataFramesCollection.setLayout(false);
 

Parameters:
value -
See Also:
isLayout()

isLayout

public boolean isLayout()
Returns true if the specifying to generate layouts for all dataframes in collection.

 if(dataFramesCollection.isLayout() == true){
  dataFramesCollection.setLayout(false);
 }
 

Returns:
true

getLayoutObject

public Layout getLayoutObject()
Returns the DataFramesCollection objects associated Layout object.

 Layout layout = dataFramesCollection.getLayoutObject();
 

Returns:
Layout

setLayoutObject

public void setLayoutObject(Layout obj)
Sets Layout object for a DataframeCollection.


generateLayout

public void generateLayout()
Generates a GET_LAYOUT request to an ArcMap service to generate an ArcMap layout.

 dataFramesCollection.generateLayout();
 


buildDataFrames

public void buildDataFrames(ConnectionProxy connector,
                            long dpi,
                            boolean loadEnvelope,
                            boolean loadRenderer,
                            boolean loadRecordset,
                            boolean loadExtensions)
                     throws Exception
Builds a collection of DataFrames from an ArcMap service.

  ConnectionProxy connectionProxy = new ConnectionProxy();
  connectionProxy.setHost("myServer");
  connectionProxy.setPort(5300);
  connectionProxy.setService("world");
  dataFramesCollection.buildDataFrames(connectionProxy, 0 , true, true, true, false);
 

Parameters:
connector - the ConnectionProxy object.
dpi -
loadEnvelope - specifies loading of layers envelopes.
loadRenderer - specifies loading of layers renderers.
loadRecordset - specifies loading of layers fields.
loadExtensions - specifies loading of layers extensions.
Throws:
Exception