|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.esri.aims.mtier.model.arcmap.DataFramesCollection
The DataFrameCollection object contains a collection of DataFrame objects. The DataFrameCollection is populated when calling the buildDataframes method.
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 |
public DataFramesCollection()
DataFramesCollection dataFramesCollection = new DataFramesCollection();
Method Detail |
public void setAutoResize(boolean value)
public boolean isAutoResize()
public ImageLimit getImageLimit()
ImageLimit imageLimit = dataFramesCollection.getImageLimit();
public Locale getLocale()
Locale locale = dataFramesCollection.getLocale();
public Separators getSeparators()
Separators separators = dataFramesCollection.getSeparators();
public UIFont getUIFont()
UIFont uiFont = dataFramesCollection.getUIFont();
public void setRetrievableDataFrameName(String value)
public String getRetrievableDataFrameName()
public void setTOC(boolean value)
public boolean getTOC()
public void setTOCType(String value)
public String getTOCType()
public void addDataFrame(DataFrame obj)
obj
- the DataFrame object.removeDataFrame(int)
,
clearDataFrames()
public int getDataFramesCount()
int count = dataFramesCollection.getDataFramesCount();
public Object removeDataFrame(int index)
dataFramesCollection.removeDataFrame(1);
index
- the DataFrame object to remove
#AddDataFrame
public void clearDataFrames()
dataFramesCollection.clearDataFrames();
addDataFrame(com.esri.aims.mtier.model.arcmap.DataFrame)
public DataFrame getDataFrame(int index)
DataFrame dataFrame = dataFramesCollection.getDataFrame(1);
index
- the DataFrame object to return.
public void setLayout(boolean value)
dataFramesCollection.setLayout(false);
value
- isLayout()
public boolean isLayout()
if(dataFramesCollection.isLayout() == true){
dataFramesCollection.setLayout(false);
}
public Layout getLayoutObject()
Layout layout = dataFramesCollection.getLayoutObject();
public void setLayoutObject(Layout obj)
public void generateLayout()
dataFramesCollection.generateLayout();
public void buildDataFrames(ConnectionProxy connector, long dpi, boolean loadEnvelope, boolean loadRenderer, boolean loadRecordset, boolean loadExtensions) throws Exception
ConnectionProxy connectionProxy = new ConnectionProxy();
connectionProxy.setHost("myServer");
connectionProxy.setPort(5300);
connectionProxy.setService("world");
dataFramesCollection.buildDataFrames(connectionProxy, 0 , true, true, true, false);
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.
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |