com.esri.arcgis.carto
Class ButtonTabStyle

java.lang.Object
  extended by com.esri.arcgis.carto.ButtonTabStyle
All Implemented Interfaces:
IGridLabel, IGridLabel2, IGridLabelExport, IIndexGridTabStyle, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class ButtonTabStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIndexGridTabStyle, IGridLabel, IGridLabel2, IGridLabelExport, IPersistStream, Externalizable

A button tab style grid label for index grids.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
ButtonTabStyle()
          Constructs a ButtonTabStyle using ArcGIS Engine.
ButtonTabStyle(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ButtonTabStyle theButtonTabStyle = (ButtonTabStyle) obj;
 
Method Summary
 IElement createElement(double labelValue, IPoint location, int axis, IDisplay display)
          Creates a graphic element for a label on the specified grid axis.
 void draw(double labelValue, IPoint location, int axis, IDisplay display)
          Draws a label on the specified grid axis.
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IColor getColor()
          The color of the grid label.
 String getDisplayName()
          The display name for the type of grid label.
 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 getFontSize()
          The font size used by the grid label.
 IColor getForegroundColor()
          The foreground color of the tab.
 double getLabelOffset()
          The offset of the grid label from the border in points.
 IColor getOutlineColor()
          The outline color of the tab.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 double getThickness()
          The thickness of the tab in points.
 int hashCode()
          the hashcode for this object
 boolean isApplies(IMapGrid grid)
          Indicates if this grid label can be used with the specified map grid.
 void isDirty()
          isDirty
 boolean isLabelAlignment(int axis)
          Indicates if the grid label is horizontal (true) or vertical (false) on the specified axis.
 void load(IStream pstm)
          load
 void prepareDraw(String labelValue, double tabWidthPage, int axis)
          Sets up the tab for drawing.
 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 readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setColor(IColor color)
          The color of the grid label.
 void setEditObject(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 setFontSize(double size)
          The font size used by the grid label.
 void setForegroundColor(IColor color)
          The foreground color of the tab.
 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.
 void setOutlineColor(IColor color)
          The outline color of the tab.
 void setThickness(double thicknessPts)
          The thickness of the tab in points.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ButtonTabStyle

public ButtonTabStyle()
               throws IOException,
                      UnknownHostException
Constructs a ButtonTabStyle using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ButtonTabStyle

public ButtonTabStyle(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ButtonTabStyle theButtonTabStyle = (ButtonTabStyle) obj;

Construct a ButtonTabStyle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ButtonTabStyle.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getForegroundColor

public IColor getForegroundColor()
                          throws IOException,
                                 AutomationException
The foreground color of the tab.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getForegroundColor in interface IIndexGridTabStyle
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setForegroundColor

public void setForegroundColor(IColor color)
                        throws IOException,
                               AutomationException
The foreground color of the tab.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getOutlineColor

public IColor getOutlineColor()
                       throws IOException,
                              AutomationException
The outline color of the tab.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutlineColor in interface IIndexGridTabStyle
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutlineColor

public void setOutlineColor(IColor color)
                     throws IOException,
                            AutomationException
The outline color of the tab.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

getThickness

public double getThickness()
                    throws IOException,
                           AutomationException
The thickness of the tab in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getThickness in interface IIndexGridTabStyle
Returns:
The thicknessPts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThickness

public void setThickness(double thicknessPts)
                  throws IOException,
                         AutomationException
The thickness of the tab in points.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setThickness in interface IIndexGridTabStyle
Parameters:
thicknessPts - The thicknessPts (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

prepareDraw

public void prepareDraw(String labelValue,
                        double tabWidthPage,
                        int axis)
                 throws IOException,
                        AutomationException
Sets up the tab for drawing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
prepareDraw in interface IIndexGridTabStyle
Parameters:
labelValue - The labelValue (in)
tabWidthPage - The tabWidthPage (in)
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayName

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayName in interface IGridLabel
Specified by:
getDisplayName in interface IGridLabel2
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isApplies

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getEditObject

public Object getEditObject()
                     throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEditObject in interface IGridLabel
Specified by:
getEditObject in interface IGridLabel2
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEditObject

public void setEditObject(Object ppObject)
                   throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEditObject in interface IGridLabel
Specified by:
setEditObject in interface IGridLabel2
Parameters:
ppObject - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFont

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFont in interface IGridLabel
Specified by:
getFont in interface IGridLabel2
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFont in interface IGridLabel
Specified by:
setFont in interface IGridLabel2
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColor

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getColor in interface IGridLabel
Specified by:
getColor in interface IGridLabel2
Returns:
A reference to a com.esri.arcgis.display.IColor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColor

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setColor in interface IGridLabel
Specified by:
setColor in interface IGridLabel2
Parameters:
color - A reference to a com.esri.arcgis.display.IColor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelOffset

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

Description

LabelOffset is the distance in points (approx. 1/72 inch) that your labels will be drawn outside of the map border. Use a negative number to inset the labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelOffset in interface IGridLabel
Specified by:
getLabelOffset in interface IGridLabel2
Returns:
The offsetPoints
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelOffset

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

Description

LabelOffset is the distance in points (approx. 1/72 inch) that your labels will be drawn outside of the map border. Use a negative number to inset the labels.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelOffset in interface IGridLabel
Specified by:
setLabelOffset in interface IGridLabel2
Parameters:
offsetPoints - The offsetPoints (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLabelAlignment

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setLabelAlignment

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setLabelAlignment in interface IGridLabel
Specified by:
setLabelAlignment in interface IGridLabel2
Parameters:
axis - A com.esri.arcgis.carto.esriGridAxisEnum constant (in)
horizontal - The horizontal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTextExtent

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryTextExtent in interface IGridLabel
Specified by:
queryTextExtent in interface IGridLabel2
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

draw

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface IGridLabel
Specified by:
draw in interface IGridLabel2
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

preview

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
preview in interface IGridLabel
Specified by:
preview in interface IGridLabel2
Parameters:
hDC - The hDC (A COM typedef) (in)
rectangle - A Structure: com.esri.arcgis.display.tagRECT (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontSize

public double getFontSize()
                   throws IOException,
                          AutomationException
The font size used by the grid label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFontSize in interface IGridLabel2
Returns:
The size
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontSize

public void setFontSize(double size)
                 throws IOException,
                        AutomationException
The font size used by the grid label.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFontSize in interface IGridLabel2
Parameters:
size - The size (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createElement

public IElement createElement(double labelValue,
                              IPoint location,
                              int axis,
                              IDisplay display)
                       throws IOException,
                              AutomationException
Creates a graphic element for a label on the specified grid axis.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
createElement in interface IGridLabelExport
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)
Returns:
A reference to a com.esri.arcgis.carto.IElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException