com.esri.arcgis.beans.ui
Class BeanHelper

java.lang.Object
  extended by com.esri.arcgis.beans.ui.BeanHelper

public class BeanHelper
extends Object

A BeanHelper is a ArcObject Java helper class. It helps ArcObject JavaBeans manipulate the status of their properties during the design-time.


Field Summary
static Font BEAN_NAME_FONT
           
static String PROPERTY_APPEARANCE
           
static String PROPERTY_BACKCOLOR
           
static String PROPERTY_BORDER_STYLE
           
static String PROPERTY_DOCUMENTFILENAME
           
static String PROPERTY_ESRIENABLED
           
static String PROPERTY_KEYINTERCEPT
           
static String PROPERTY_MOUSEPOINTER
           
static String PROPERTY_OLEDROPENABLED
           
static String PROPERTY_SHOWMAPTIPS
           
static String PROPERTY_SHOWSCROLLBARS
           
static String PROPERTY_TIPSTYLE
           
 
Constructor Summary
BeanHelper()
           
 
Method Summary
 void addTimerAction(ActionListener listener)
          Adds an ActionListener to the internal timer.
 boolean esri_isEnabled()
          Returns true if the component is enabled.
 void esri_setEnabled(boolean rhs1)
           
 int getAppearance()
          Gets the appearance
 int getBackColor()
          Returns the background color
 int getBorderStyle()
          Gets the border style
 Dimension getDefaultPerferredSize()
          Returns the default size
 String getDocumentFilename()
          Returns the document filename
 int getKeyIntercept()
          return 1 if the key intercept is enabled.
 int getMousePointer()
          Gets the mouse pointer style
 int getTipStyle()
          Gets the tips style.
 boolean isOleDropEnabled()
          Return ture if the OLE srop event is enabled.
 boolean isOnlyOnce()
           
 boolean isRunning()
          Tests if the timer is still running
 boolean isShowMapTips()
          Returns true if the map tips is shown
 boolean isShowScrollbars()
          Returns ture if the scroll bar is visible, otherwise is false;
 void paintInDesignTime(Graphics g, Dimension d, String name, Image image, boolean page)
          Paints the name of the component during the design-time.
 void setAppearance(int appearance)
          Sets the appearance
 void setBackColor(int rhs1)
          Sets the background color.
 void setBorderStyle(int borderStyle)
          Sets border style
 void setDocumentFilename(String filename)
          Sets a document filename
 void setKeyIntercept(int key)
          Enables key intercept if the key = 1
 void setMousePointer(int mousePointer)
          Sets the mouse pointer style
 void setOleDropEnabled(boolean ole)
          Sets OLE drop event is eanbled.
 void setShowMapTips(boolean tips)
          Sets if the map tips is shown
 void setShowScrollbars(boolean rhs1)
          Sets the scroll bar is invisible ot visible.
 void setTipStlyes(int style)
          Sets the tips style.
 void startTimer()
          Sterts an internal timer.
 void stopTimer()
          Stops the internal timer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_BORDER_STYLE

public static final String PROPERTY_BORDER_STYLE
See Also:
Constant Field Values

PROPERTY_APPEARANCE

public static final String PROPERTY_APPEARANCE
See Also:
Constant Field Values

PROPERTY_MOUSEPOINTER

public static final String PROPERTY_MOUSEPOINTER
See Also:
Constant Field Values

PROPERTY_TIPSTYLE

public static final String PROPERTY_TIPSTYLE
See Also:
Constant Field Values

PROPERTY_OLEDROPENABLED

public static final String PROPERTY_OLEDROPENABLED
See Also:
Constant Field Values

PROPERTY_KEYINTERCEPT

public static final String PROPERTY_KEYINTERCEPT
See Also:
Constant Field Values

PROPERTY_ESRIENABLED

public static final String PROPERTY_ESRIENABLED
See Also:
Constant Field Values

PROPERTY_SHOWSCROLLBARS

public static final String PROPERTY_SHOWSCROLLBARS
See Also:
Constant Field Values

PROPERTY_SHOWMAPTIPS

public static final String PROPERTY_SHOWMAPTIPS
See Also:
Constant Field Values

PROPERTY_BACKCOLOR

public static final String PROPERTY_BACKCOLOR
See Also:
Constant Field Values

PROPERTY_DOCUMENTFILENAME

public static final String PROPERTY_DOCUMENTFILENAME
See Also:
Constant Field Values

BEAN_NAME_FONT

public static final Font BEAN_NAME_FONT
Constructor Detail

BeanHelper

public BeanHelper()
Method Detail

getDefaultPerferredSize

public Dimension getDefaultPerferredSize()
Returns the default size

Returns:
Dimension a Dimension object

paintInDesignTime

public void paintInDesignTime(Graphics g,
                              Dimension d,
                              String name,
                              Image image,
                              boolean page)
Paints the name of the component during the design-time.

Parameters:
g - Graphics a Graphic content object
d - Dimension a speified dimension
name - String a bean nane
page - boolean ture if it is a PageLayout bean

addTimerAction

public void addTimerAction(ActionListener listener)
Adds an ActionListener to the internal timer.

Parameters:
listener - ActionListener

stopTimer

public void stopTimer()
Stops the internal timer


isRunning

public boolean isRunning()
Tests if the timer is still running

Returns:
boolean true/false

startTimer

public void startTimer()
Sterts an internal timer.


isOnlyOnce

public boolean isOnlyOnce()

setBorderStyle

public void setBorderStyle(int borderStyle)
Sets border style

Parameters:
borderStyle - int

getBorderStyle

public int getBorderStyle()
Gets the border style

Returns:
int

setAppearance

public void setAppearance(int appearance)
Sets the appearance

Parameters:
appearance - int

getAppearance

public int getAppearance()
Gets the appearance

Returns:
int

setMousePointer

public void setMousePointer(int mousePointer)
Sets the mouse pointer style

Parameters:
mousePointer - int

getMousePointer

public int getMousePointer()
Gets the mouse pointer style

Returns:
int

setTipStlyes

public void setTipStlyes(int style)
Sets the tips style.

Parameters:
style - int

getTipStyle

public int getTipStyle()
Gets the tips style.

Returns:
int

setKeyIntercept

public void setKeyIntercept(int key)
Enables key intercept if the key = 1

Parameters:
key - int

getKeyIntercept

public int getKeyIntercept()
return 1 if the key intercept is enabled.

Returns:
int

setOleDropEnabled

public void setOleDropEnabled(boolean ole)
Sets OLE drop event is eanbled.

Parameters:
ole - boolean

isOleDropEnabled

public boolean isOleDropEnabled()
Return ture if the OLE srop event is enabled.

Returns:
boolean

setShowMapTips

public void setShowMapTips(boolean tips)
Sets if the map tips is shown

Parameters:
tips - boolean

isShowMapTips

public boolean isShowMapTips()
Returns true if the map tips is shown

Returns:
boolean

esri_isEnabled

public boolean esri_isEnabled()
Returns true if the component is enabled.

Returns:
boolean

esri_setEnabled

public void esri_setEnabled(boolean rhs1)

isShowScrollbars

public boolean isShowScrollbars()
Returns ture if the scroll bar is visible, otherwise is false;

Returns:
boolean

setShowScrollbars

public void setShowScrollbars(boolean rhs1)
Sets the scroll bar is invisible ot visible.

Parameters:
rhs1 - boolean

getBackColor

public int getBackColor()
Returns the background color

Returns:
int

setBackColor

public void setBackColor(int rhs1)
Sets the background color.

Parameters:
rhs1 - int

setDocumentFilename

public void setDocumentFilename(String filename)
Sets a document filename

Parameters:
filename - String

getDocumentFilename

public String getDocumentFilename()
Returns the document filename

Returns:
String