|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.framework.BasePropertyPage com.esri.arcgis.cartoUI.BaseCustomRendererPropertyPage
public abstract class BaseCustomRendererPropertyPage
BaseCustomRendererPropertyPage is the base class which Java implementations of a Custom renderer property page should extend from.
Implementations of a Custom renderer property page should define a Java user interface that derives from javax.swing.JFrame
.
It is recommended to keep the implementation of the user interface seperate from the implementation of the class that derives
from BaseCustomRendererPropertyPage. For example,
Field Summary |
---|
Fields inherited from interface com.esri.arcgis.framework.IComEmbeddedPropertyPage |
---|
IID, IID063304c3_7b90_48e9_b2d3_e795a8ba926b, xxDummy |
Fields inherited from interface com.esri.arcgis.cartoUI.IRendererPropertyPage |
---|
IID, IID44bd4d21_5f47_11d0_92da_00805f7c28b0, xxDummy |
Fields inherited from interface com.esri.arcgis.framework.IComPropertyPage |
---|
IID, IID76951cc6_dbb1_11d2_b868_00600802e603, xxDummy |
Constructor Summary | |
---|---|
BaseCustomRendererPropertyPage()
|
Method Summary | |
---|---|
boolean |
applies(ISet objects)
Indicates if the page applies to the specified objects. |
void |
apply()
Applies any changes to the object(s). |
abstract void |
apply(IFeatureRenderer yourCustomRenderer)
Applies property changes onto the Custom renderer. |
boolean |
canEdit(IFeatureRenderer obj)
Indicates if the property page can modify the properties of the specified renderer. |
java.lang.Object |
createCompatibleObject(java.lang.Object kind)
Create a new object using the specified object as a template. |
IUID |
getClassID()
Property page class id (unique identifier object). |
abstract java.lang.Class |
getCustomRendererDef()
|
abstract java.lang.String |
getDescription()
Renderer description. |
abstract java.lang.String |
getName()
Name of the renderer. |
abstract int |
getPreviewImage()
Preview bitmap for the renderer that appears on the page. |
IUID |
getRendererClassID()
Renderer class id (unique identifier object). |
java.lang.String |
getTitle()
The title of the property page. |
abstract java.lang.String |
getType()
Renderer type. |
javax.swing.JFrame |
initGUI()
|
abstract javax.swing.JFrame |
initGUI(IFeatureRenderer yourCustomRender)
Initializes the User Interface with default properties of a Custom renderer. |
void |
queryObject(java.lang.Object theObject)
Apply the property page settings to the specified object. |
void |
setObjects(ISet objects)
Supplies the page with the object(s) to be edited. |
Methods inherited from class com.esri.arcgis.framework.BasePropertyPage |
---|
activate, cancel, deactivate, getHeight, getHelpContextID, getHelpFile, getPriority, getWidth, hide, IComPropertyPage_isPageDirty, pageChanged, repaintJFrame, setPageSiteByRef, setPriority, setTitle, show |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BaseCustomRendererPropertyPage()
Method Detail |
---|
public abstract void apply(IFeatureRenderer yourCustomRenderer)
Since this method is not called on Java's EDT thread it is unsafe to modify properties of user interface elements residing on the property page.
It is safe to use the ArcObjects API within this method.
yourCustomRenderer
- the Custom renderer that is associated with this property pagepublic abstract java.lang.Class getCustomRendererDef()
public abstract javax.swing.JFrame initGUI(IFeatureRenderer yourCustomRender)
javax.swing.JFrame
and returns it
to the ArcGIS runtime. This method is passed in a reference to an instance of a Custom renderer
from which default properties of the custom renderer can be obtained to initialize the user interface *
Implementations of this method should not call methods to realize the JFrame; example, setVisible(true). Visibility of the JFrame and it's life-cycle management is performed internally by the ArcGIS runtime.
It is safe to use the ArcObjects API within this method.
yourCustomRenderer
- the Custom reference that is associated with this property page
public javax.swing.JFrame initGUI()
initGUI
in class BasePropertyPage
public final boolean applies(ISet objects) throws java.io.IOException, AutomationException
BasePropertyPage
applies
in interface IComPropertyPage
applies
in class BasePropertyPage
objects
- A reference to a com.esri.arcgis.system.ISet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final void apply() throws AutomationException, java.io.IOException
BasePropertyPage
apply
in interface IComPropertyPage
apply
in class BasePropertyPage
AutomationException
- If the ArcObject component throws an exception.
java.io.IOException
- If there are interop problems.public final java.lang.String getTitle()
BasePropertyPage
getTitle
in interface IComPropertyPage
getTitle
in class BasePropertyPage
public final void setObjects(ISet objects) throws java.io.IOException, AutomationException
BasePropertyPage
setObjects
in interface IComPropertyPage
setObjects
in class BasePropertyPage
objects
- A reference to a com.esri.arcgis.system.ISet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final java.lang.Object createCompatibleObject(java.lang.Object kind) throws java.io.IOException, AutomationException
createCompatibleObject
in interface IComEmbeddedPropertyPage
kind
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final void queryObject(java.lang.Object theObject) throws java.io.IOException, AutomationException
queryObject
in interface IComEmbeddedPropertyPage
theObject
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final boolean canEdit(IFeatureRenderer obj) throws java.io.IOException, AutomationException
canEdit
in interface IRendererPropertyPage
obj
- A reference to a (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final IUID getClassID() throws java.io.IOException, AutomationException
getClassID
in interface IRendererPropertyPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public final IUID getRendererClassID() throws java.io.IOException, AutomationException
getRendererClassID
in interface IRendererPropertyPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getDescription() throws java.io.IOException, AutomationException
getDescription
in interface IRendererPropertyPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface IRendererPropertyPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract int getPreviewImage() throws java.io.IOException, AutomationException
getPreviewImage
in interface IRendererPropertyPage
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public abstract java.lang.String getType() throws java.io.IOException, AutomationException
getType
in interface IRendererPropertyPage
java.io.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 |