|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILegendGroup
Provides access to members that control the collection of legend classes provided by a renderer.
This interface manages an
array of LegendClass objects. Inside a LegendClass object is one
Symbol object. Classes can be looked up, but modifying the number
of classes through addition, insertion, and deletion is the job of
the renderer object.
Method Summary | |
---|---|
void |
addClass(ILegendClass legendClass)
Adds a new legend class to the group at the end of list. |
void |
clearClasses()
Removes all classes from the group. |
ILegendClass |
esri_getClass(int index)
Legend class at the specified index. |
int |
getClassCount()
Number of legend classes in the group. |
String |
getHeading()
String heading. |
void |
insertClass(int index,
ILegendClass legendClass)
Inserts a new legend class into the group at the specified index. |
boolean |
isEditable()
Indicates if the group can be edited. |
boolean |
isVisible()
Indicates if the group is displayed. |
void |
removeClass(int index)
Removes the legend class from the group at the specified index. |
void |
setEditable(boolean editable)
Indicates if the group can be edited. |
void |
setHeading(String heading)
String heading. |
void |
setVisible(boolean visible)
Indicates if the group is displayed. |
Method Detail |
---|
boolean isVisible() throws IOException, AutomationException
This property indicates whether or not a layer's entry in the table of contents is expanded or collapsed. If a layer has only one legend group, then if Visible = True, then the layer is expanded. If a layer has more than one legend group, then the rule is that if any of the the layer's legend groups are visible, then the layer's entry in the table of contents is expanded.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setVisible(boolean visible) throws IOException, AutomationException
visible
- The visible (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isEditable() throws IOException, AutomationException
This property indicates
whether or not the symbols and text strings in the LegendClass
objects of a LegendGroup can be edited. If this property is False
then the user cannot edit the group's symbols and text labels in
the ArcMap table of contents.
For example, the legend for a layer symbolized with a
ChartRenderer with PieChartSymbols consists of two legend groups.
The first legend group contains a representative pie chart symbol
and is not editable. The second legend group contains the
individual fill symbols that make up the pie chart slices, and this
legend group is editable.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setEditable(boolean editable) throws IOException, AutomationException
editable
- The editable (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getHeading() throws IOException, AutomationException
This property is the text string that describes the content of the legend group. This text string appears in the table of contents and can appear also in the legend. This string is typically generated by the renderer, but can be modified after creation by the user.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHeading(String heading) throws IOException, AutomationException
heading
- The heading (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getClassCount() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILegendClass esri_getClass(int index) throws IOException, AutomationException
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void addClass(ILegendClass legendClass) throws IOException, AutomationException
Modifying the number of classes in a LegendGroup through addition, insertion, and deletion is the job of the renderer object.
legendClass
- A reference to a com.esri.arcgis.carto.ILegendClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void insertClass(int index, ILegendClass legendClass) throws IOException, AutomationException
Modifying the number of classes in a LegendGroup through addition, insertion, and deletion is the job of the renderer object.
index
- The index (in)legendClass
- A reference to a com.esri.arcgis.carto.ILegendClass (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeClass(int index) throws IOException, AutomationException
Modifying the number of classes in a LegendGroup through addition, insertion, and deletion is the job of the renderer object.
index
- The index (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void clearClasses() throws IOException, AutomationException
Modifying the number of classes in a LegendGroup through addition, insertion, and deletion is the job of the renderer object.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |