com.esri.arcgis.carto
Interface IGridLabel

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BackgroundTabStyle, ButtonTabStyle, ContinuousTabStyle, CornerGridLabel, DMSGridLabel, FormattedGridLabel, IGridLabelProxy, MixedFontGridLabel, RoundedTabStyle

public interface IGridLabel
extends java.io.Serializable

COM Interface 'IGridLabel'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the way a map grid is labeled.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDce41c501_9df9_11d2_aade_000000000000
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void draw(double labelValue, IPoint location, int axis, IDisplay display)
          Draws a label on the specified grid axis.
 IColor getColor()
          The color of the grid label.
 java.lang.String getDisplayName()
          The display name for the type of grid label.
 java.lang.Object getEditObject()
          The interface to an object that can be edited with a property sheet.
 Font getFont()
          The font used by the grid label.
 double getLabelOffset()
          The offset of the grid label from the border in points.
 boolean isApplies(IMapGrid grid)
          Indicates if this grid label can be used with the specified map grid.
 boolean isLabelAlignment(int axis)
          Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
 void preview(int hDC, tagRECT rectangle)
          Draws a preview of the grid label into the specified hdc.
 void queryTextExtent(double labelValue, IPoint location, int axis, IDisplay display, IEnvelope extent)
          Determines the extent of a label's text on the specified grid axis.
 void setColor(IColor color)
          The color of the grid label.
 void setEditObject(java.lang.Object ppObject)
          The interface to an object that can be edited with a property sheet.
 void setFont(Font font)
          The font used by the grid label.
 void setLabelAlignment(int axis, boolean horizontal)
          Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
 void setLabelOffset(double offsetPoints)
          The offset of the grid label from the border in points.
 

Field Detail

IIDce41c501_9df9_11d2_aade_000000000000

static final int IIDce41c501_9df9_11d2_aade_000000000000
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getDisplayName

java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException
The display name for the type of grid label.

Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isApplies

boolean isApplies(IMapGrid grid)
                  throws java.io.IOException,
                         AutomationException
Indicates if this grid label can be used with the specified map grid.

Parameters:
grid - A reference to a com.esri.arcgis.carto.IMapGrid (in)
Returns:
The applies
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEditObject

java.lang.Object getEditObject()
                               throws java.io.IOException,
                                      AutomationException
The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Returns:
A reference to another Object (IUnknown)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEditObject

void setEditObject(java.lang.Object ppObject)
                   throws java.io.IOException,
                          AutomationException
The interface to an object that can be edited with a property sheet. The object is either the grid label itself or a single editable property.

Parameters:
ppObject - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFont

Font getFont()
             throws java.io.IOException,
                    AutomationException
The font used by the grid label.

Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

void setFont(Font font)
             throws java.io.IOException,
                    AutomationException
The font used by the grid label.

Parameters:
font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

IColor getColor()
                throws java.io.IOException,
                       AutomationException
The color of the grid label.

Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColor

void setColor(IColor color)
              throws java.io.IOException,
                     AutomationException
The color of the grid label.

Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelOffset

double getLabelOffset()
                      throws java.io.IOException,
                             AutomationException
The offset of the grid label from the border in points.

Returns:
The offsetPoints
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelOffset

void setLabelOffset(double offsetPoints)
                    throws java.io.IOException,
                           AutomationException
The offset of the grid label from the border in points.

Parameters:
offsetPoints - The offsetPoints (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLabelAlignment

boolean isLabelAlignment(int axis)
                         throws java.io.IOException,
                                AutomationException
Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Parameters:
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
Returns:
The horizontal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelAlignment

void setLabelAlignment(int axis,
                       boolean horizontal)
                       throws java.io.IOException,
                              AutomationException
Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.

Parameters:
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
horizontal - The horizontal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTextExtent

void queryTextExtent(double labelValue,
                     IPoint location,
                     int axis,
                     IDisplay display,
                     IEnvelope extent)
                     throws java.io.IOException,
                            AutomationException
Determines the extent of a label's text on the specified grid axis.

Parameters:
labelValue - The labelValue (in)
location - A reference to a com.esri.arcgis.geometry.IPoint (in)
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

void draw(double labelValue,
          IPoint location,
          int axis,
          IDisplay display)
          throws java.io.IOException,
                 AutomationException
Draws a label on the specified grid axis.

Parameters:
labelValue - The labelValue (in)
location - A reference to a com.esri.arcgis.geometry.IPoint (in)
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

preview

void preview(int hDC,
             tagRECT rectangle)
             throws java.io.IOException,
                    AutomationException
Draws a preview of the grid label into the specified hdc.

Parameters:
hDC - The hDC (A COM typedef) (in)
rectangle - A Structure: com.esri.arcgis.system.tagRECT (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.