|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.aims.mtier.model.map.output.Output com.esri.aims.mtier.model.map.output.LegendOutput
public class LegendOutput
The LegendOutput object can be used to set specific parameters to be used in creating a legend image. The LegendOutput object is also used for storing the location for the newly created legend image. The LegendOutput object extends the Output object.
Constructor Summary | |
---|---|
LegendOutput()
Constructs an instance of a LegendOutput object. |
Method Summary | |
---|---|
String |
getFile()
Returns the file value associated with this LegendOutput object for the response. |
String |
getFileType()
Returns the output image file type. |
String |
getLegendBaseURL()
Returns the legendbaseurl property as a string. |
String |
getLegendName()
Returns the associated legend name as string. |
String |
getLegendPath()
Returns the associated legend path as string. |
String |
getLegendURL()
Returns the associated legend URL. |
String |
getType()
Returns the name string defining the type of Output object. |
void |
setFile(String value)
Sets the LegendOutput objects file value. |
void |
setFileType(String value)
Sets the output image file type. |
void |
setLegendBaseURL(String value)
This method is paired with setLegendPath , and is used to
set the legend image baseurl. |
void |
setLegendName(String value)
This method, when paired with setLegendURL , assigns an output legend filename. |
void |
setLegendPath(String value)
Sets the directory to output the legend file generated. |
void |
setLegendURL(String value)
This method when paired with setLegendName , sets the URL
location to place the generated legend image. |
Methods inherited from class com.esri.aims.mtier.model.map.output.Output |
---|
getOutputURL, getURL, setOutputURL, setURL, setURL |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LegendOutput()
LegendOutput legendOutput = new LegendOutput();
Method Detail |
---|
public String getType()
getType
in class Output
public void setLegendBaseURL(String value)
setLegendPath
, and is used to
set the legend image baseurl. It sets the URL of the output directory if
the default legend filename is generated by ArcIMS.
Example: legendOutput.setLegendBaseURL("http://www.mapper.com");
value
- the url.getLegendBaseURL()
public String getLegendBaseURL()
legendbaseurl
property as a string.
Example: String legendBaseURL = legendOutput.getLegendBaseURL();
legendbaseurl
property as a string.setLegendBaseURL(java.lang.String)
public void setLegendName(String value)
setLegendURL
, assigns an output legend filename.
Note to use full pathname along with the filename.
Example: legendOutput.setLegendName("MyLegend");
value
- the filename value.getLegendName()
,
setLegendURL(java.lang.String)
public String getLegendName()
String legendName = legendOutput.getLegendName();
setLegendName(java.lang.String)
public void setLegendURL(String value)
setLegendName
, sets the URL
location to place the generated legend image.
Example: legendOutput.setLegendURL("http://www.abcmap.com");
value
- the url value.getLegendURL()
,
setLegendName(java.lang.String)
public String getLegendURL()
String legURL = legendOutput.getLegendURL();
setLegendURL(java.lang.String)
public void setFileType(String value)
legendOutput.setFileType("png");
value
- the output file type.getFileType()
public String getFileType()
String fileType = legendOutput.getType();
setFileType(java.lang.String)
public void setLegendPath(String value)
legendOutput.setLegendPath("C:/ArcIMS/Output");
value
- the legend path value.getLegendPath()
public String getLegendPath()
String legendPath = legendOutput.getLegendPath();
setLegendPath(java.lang.String)
public void setFile(String value)
legendOutput.setFile("legend");
value
- the file value.getFile()
public String getFile()
String file = legendOutput.getFile();
setFile(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |