com.esri.arcgis.display
Class ServerStyleGallery

java.lang.Object
  extended by com.esri.arcgis.display.ServerStyleGallery
All Implemented Interfaces:
IStyleGallery, IStyleGalleryStorage, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class ServerStyleGallery
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IStyleGallery, IStyleGalleryStorage, IPersistStream, java.io.Externalizable

COM Class 'ServerStyleGallery'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'The Server Style Gallery.' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.display.IStyleGallery
IID, IIDac0e9826_91cb_11d1_8813_080009ec732a, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IStyleGalleryStorage
IID, IID001d15b3_0f79_11d2_adfe_080009ec732a, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
ServerStyleGallery()
          Constructs a ServerStyleGallery using ArcGIS Engine.
ServerStyleGallery(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerStyleGallery theServerStyleGallery = (ServerStyleGallery) obj;
 
Method Summary
 void addFile(java.lang.String path)
          Adds a file to the Style Gallery.
 void addItem(IStyleGalleryItem item)
          Adds an item to the target style file.
 void clear()
          Removes all styles from the Style Gallery.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IStyleGalleryClass esri_getClass(int index)
          The class at the given index.
 IEnumBSTR getCategories(java.lang.String className)
          The categories within the given class.
 int getClassCount()
          Number of classes in the Style Gallery.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getDefaultStylePath()
          The default file path for searching for standard styles.
 java.lang.String getFile(int index)
          The file at the given index.
 int getFileCount()
          The number of files in the Style Gallery.
 IEnumStyleGalleryItem getItems(java.lang.String className, java.lang.String styleSet, java.lang.String category)
          The style items from the specified style file, in the specified class and category.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getTargetFile()
          The target output file for adding, updating and removing items.
 int hashCode()
          the hashcode for this object
 void importStyle(java.lang.String fileName)
          Imports a style from a file other than a .style file.
 boolean isCanUpdate(java.lang.String path)
          Indicates if the specified file can be updated.
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void loadStyle(java.lang.String fileName, java.lang.String className)
          Loads a style from a file.
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a ServerStyleGallery.
 void removeFile(java.lang.String path)
          Removes a file from the Style Gallery.
 void removeItem(IStyleGalleryItem item)
          Removes an item from the target style file.
 void save(IStream pstm, int fClearDirty)
          save
 void saveStyle(java.lang.String fileName, java.lang.String styleSet, java.lang.String className)
          Saves the specified style to a file.
 void setTargetFile(java.lang.String path)
          The target output file for adding, updating and removing items.
 void updateItem(IStyleGalleryItem item)
          Updates an existing item in target style file.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

ServerStyleGallery

public ServerStyleGallery()
                   throws java.io.IOException,
                          java.net.UnknownHostException
Constructs a ServerStyleGallery using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ServerStyleGallery

public ServerStyleGallery(java.lang.Object obj)
                   throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ServerStyleGallery theServerStyleGallery = (ServerStyleGallery) obj;

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

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

getClsid

public static java.lang.String getClsid()
getClsid.


equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ServerStyleGallery.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getClassCount

public int getClassCount()
                  throws java.io.IOException,
                         AutomationException
Number of classes in the Style Gallery.

Specified by:
getClassCount in interface IStyleGallery
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public IStyleGalleryClass esri_getClass(int index)
                                 throws java.io.IOException,
                                        AutomationException
The class at the given index.

Specified by:
esri_getClass in interface IStyleGallery
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.display.IStyleGalleryClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategories

public IEnumBSTR getCategories(java.lang.String className)
                        throws java.io.IOException,
                               AutomationException
The categories within the given class.

Specified by:
getCategories in interface IStyleGallery
Parameters:
className - The className (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItems

public IEnumStyleGalleryItem getItems(java.lang.String className,
                                      java.lang.String styleSet,
                                      java.lang.String category)
                               throws java.io.IOException,
                                      AutomationException
The style items from the specified style file, in the specified class and category. The style set and category may be blank to return all items.

Specified by:
getItems in interface IStyleGallery
Parameters:
className - The className (in)
styleSet - The styleSet (in)
category - The category (in)
Returns:
A reference to a com.esri.arcgis.display.IEnumStyleGalleryItem
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addItem

public void addItem(IStyleGalleryItem item)
             throws java.io.IOException,
                    AutomationException
Adds an item to the target style file.

Specified by:
addItem in interface IStyleGallery
Parameters:
item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateItem

public void updateItem(IStyleGalleryItem item)
                throws java.io.IOException,
                       AutomationException
Updates an existing item in target style file.

Specified by:
updateItem in interface IStyleGallery
Parameters:
item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeItem

public void removeItem(IStyleGalleryItem item)
                throws java.io.IOException,
                       AutomationException
Removes an item from the target style file.

Specified by:
removeItem in interface IStyleGallery
Parameters:
item - A reference to a com.esri.arcgis.display.IStyleGalleryItem (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws java.io.IOException,
                  AutomationException
Removes all styles from the Style Gallery.

Specified by:
clear in interface IStyleGallery
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadStyle

public void loadStyle(java.lang.String fileName,
                      java.lang.String className)
               throws java.io.IOException,
                      AutomationException
Loads a style from a file. If class is specified, only items in that class will be loaded.

Specified by:
loadStyle in interface IStyleGallery
Parameters:
fileName - The fileName (in)
className - The className (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveStyle

public void saveStyle(java.lang.String fileName,
                      java.lang.String styleSet,
                      java.lang.String className)
               throws java.io.IOException,
                      AutomationException
Saves the specified style to a file. If class is specified, only items in that class will be saved.

Specified by:
saveStyle in interface IStyleGallery
Parameters:
fileName - The fileName (in)
styleSet - The styleSet (in)
className - The className (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

importStyle

public void importStyle(java.lang.String fileName)
                 throws java.io.IOException,
                        AutomationException
Imports a style from a file other than a .style file.

Specified by:
importStyle in interface IStyleGallery
Parameters:
fileName - The fileName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileCount

public int getFileCount()
                 throws java.io.IOException,
                        AutomationException
The number of files in the Style Gallery.

Specified by:
getFileCount in interface IStyleGalleryStorage
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFile

public java.lang.String getFile(int index)
                         throws java.io.IOException,
                                AutomationException
The file at the given index.

Specified by:
getFile in interface IStyleGalleryStorage
Parameters:
index - The index (in)
Returns:
The path
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUpdate

public boolean isCanUpdate(java.lang.String path)
                    throws java.io.IOException,
                           AutomationException
Indicates if the specified file can be updated.

Specified by:
isCanUpdate in interface IStyleGalleryStorage
Parameters:
path - The path (in)
Returns:
The canUpdate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTargetFile

public java.lang.String getTargetFile()
                               throws java.io.IOException,
                                      AutomationException
The target output file for adding, updating and removing items.

Specified by:
getTargetFile in interface IStyleGalleryStorage
Returns:
The path
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTargetFile

public void setTargetFile(java.lang.String path)
                   throws java.io.IOException,
                          AutomationException
The target output file for adding, updating and removing items.

Specified by:
setTargetFile in interface IStyleGalleryStorage
Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFile

public void addFile(java.lang.String path)
             throws java.io.IOException,
                    AutomationException
Adds a file to the Style Gallery.

Specified by:
addFile in interface IStyleGalleryStorage
Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFile

public void removeFile(java.lang.String path)
                throws java.io.IOException,
                       AutomationException
Removes a file from the Style Gallery.

Specified by:
removeFile in interface IStyleGalleryStorage
Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultStylePath

public java.lang.String getDefaultStylePath()
                                     throws java.io.IOException,
                                            AutomationException
The default file path for searching for standard styles.

Specified by:
getDefaultStylePath in interface IStyleGalleryStorage
Returns:
The path
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

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

save

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

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

getSizeMax

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

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

getClassID

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

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

writeExternal

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

readExternal

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