Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
com.generalrobotix.ui.GrxBasePlugin Class Reference
Inheritance diagram for com.generalrobotix.ui.GrxBasePlugin:
Inheritance graph
[legend]

Classes

class  ValueEditCombo
 
class  ValueEditText
 
class  ValueEditType
 

Public Member Functions

void addObserver (GrxObserver v)
 
GrxBasePlugin clone ()
 Override clone method. More...
 
void deleteObserver (GrxObserver v)
 
boolean equals (Object obj)
 check whether obj equals to this More...
 
Element getElement ()
 get element More...
 
Image getIcon ()
 get icon More...
 
Vector< Action > getMenu ()
 get menu More...
 
String [] getMenuPath ()
 get menu path More...
 
final String getName ()
 get name More...
 
ArrayList< GrxObservergetObserver ()
 
String getOldName ()
 
Vector< MenuManager > getSubMenu ()
 get subMenu More...
 
String getURL (boolean expand)
 
ValueEditType GetValueEditType (String key)
 Return editing type of the key item. More...
 
boolean isExclusive ()
 check whether this is exclusive or not More...
 
boolean isSelected ()
 check whether this is selected or not More...
 
void notifyObservers (Object... arg)
 
boolean propertyChanged (String property, String value)
 check validity of new value of property and update if valid More...
 
boolean registerCORBA ()
 
void rename (String newName)
 rename this item More...
 
void restoreProperties ()
 restore properties. Called by menu item "restore Properties" More...
 
void setDocument (Document doc)
 set document More...
 
void setElement (Element element)
 set element More...
 
void setExclusive (boolean b)
 set exclusive flag More...
 
void setFocused (boolean b)
 set/unset focus on this plugin More...
 
void setMenuItem (Action a)
 add a menu item More...
 
void setName (String name)
 set name More...
 
Object setProperty (String key, String value)
 set property value associated with a keyword More...
 
void setSelected (boolean b)
 set selected flag More...
 
void setSubMenu (MenuManager m)
 add a submenu More...
 
void setURL (String url)
 set URL property More...
 
void shutdown ()
 
Element storeProperties ()
 store properties More...
 
final String toString ()
 convert to String. Currently, name is returned. More...
 
void unregisterCORBA ()
 
- Public Member Functions inherited from com.generalrobotix.ui.util.GrxConfigBundle
final Double getDbl (String key, Double defaultVal)
 get double value associated to key More...
 
Double getDbl (String value)
 
final double [] getDblAry (String key, double[] defaultVal)
 get double array associated to key More...
 
double [] getDblAry (String value)
 get array of double from String More...
 
final Float getFlt (String key, Float defaultVal)
 get float value associated to key More...
 
final Float getFlt (String value)
 
final float [] getFltAry (String key, float[] defaultVal)
 get float array associated to key More...
 
float [] getFltAry (String value)
 
final Integer getInt (String key, Integer defaultVal)
 get integer value associated to key More...
 
final int [] getIntAry (String key)
 get integer array associated to key More...
 
final Short getShort (String key, Short defaultVal)
 get short value associated to key More...
 
Short getShort (String value)
 
final String getStr (String key)
 get value associated to keyword More...
 
final String getStr (String key, String defaultVal)
 get value associated to key More...
 
 GrxConfigBundle ()
 constructor More...
 
 GrxConfigBundle (String fname) throws IOException
 construct from a file More...
 
final boolean isFalse (String key)
 check whether value associated to key includes a word "false" More...
 
final boolean isFalse (String key, boolean defaultVal)
 check whether value associated to key includes a word "false" More...
 
final boolean isTrue (String key)
 check whether value associated to key includes a word "true" More...
 
final boolean isTrue (String key, boolean defaultVal)
 check whether value associated to key includes a word "true" More...
 
void load (String fname) throws IOException
 load config from a file More...
 
final void setBool (String key, boolean value)
 
final void setDbl (String key, double value)
 associate double value to key More...
 
final void setDbl (String key, double value, int digits)
 associate double value to key More...
 
final void setDblAry (String key, double[] value, int digits)
 associate double array to key More...
 
final void setDblAry (String key, double[] value)
 associate double array to key More...
 
final void setFlt (String key, float value)
 associate float value to key More...
 
final void setFltAry (String key, float[] value)
 associate float array to key More...
 
final void setInt (String key, int value)
 associate int value to key More...
 
final void setShort (String key, short value)
 associate short value to key More...
 
void store (String fname, String comments) throws IOException
 store this config More...
 

Static Public Member Functions

static Object getField (Class<? extends GrxBasePlugin > cls, String field, Object defaultValue)
 get field More...
 

Protected Member Functions

 GrxBasePlugin (String name, GrxPluginManager manager)
 constructor More...
 
void setIcon (String iconName)
 set icon More...
 
void setMenuPath (String[] path)
 set menu path More...
 
boolean syncExec (Runnable r)
 Transfer SWT UI thread. More...
 

Protected Attributes

Document doc_
 
Element element_
 
GrxPluginManager manager_
 

Static Protected Attributes

static final String [] booleanComboItem_ = new String[] {"true", "false" }
 
static final String INDENT4 = " "
 
static final String ITEM_TAG = "item"
 
static final String PROPERTY_TAG = "property"
 
static final String VIEW_TAG = "view"
 

Private Attributes

String iconName_
 
ImageRegistry ireg_
 
boolean isExclusive_ = false
 
Vector< Action > menu_ = new Vector<Action>()
 
String [] menuPath_
 
String name_
 
ArrayList< GrxObserverobservers_ = new ArrayList<GrxObserver>()
 
String oldName_
 
boolean selected_ = true
 
Vector< MenuManager > subMenu_ = new Vector<MenuManager>()
 
String url_
 

Detailed Description

Definition at line 50 of file GrxBasePlugin.java.

Constructor & Destructor Documentation

◆ GrxBasePlugin()

com.generalrobotix.ui.GrxBasePlugin.GrxBasePlugin ( String  name,
GrxPluginManager  manager 
)
inlineprotected

constructor

Parameters
namename of this plugin
managerplugin manager

Definition at line 82 of file GrxBasePlugin.java.

Member Function Documentation

◆ addObserver()

void com.generalrobotix.ui.GrxBasePlugin.addObserver ( GrxObserver  v)
inline

Definition at line 491 of file GrxBasePlugin.java.

◆ clone()

GrxBasePlugin com.generalrobotix.ui.GrxBasePlugin.clone ( )
inline

Override clone method.

Returns
GrxBasePlugin

Definition at line 434 of file GrxBasePlugin.java.

◆ deleteObserver()

void com.generalrobotix.ui.GrxBasePlugin.deleteObserver ( GrxObserver  v)
inline

Definition at line 495 of file GrxBasePlugin.java.

◆ equals()

boolean com.generalrobotix.ui.GrxBasePlugin.equals ( Object  obj)
inline

check whether obj equals to this

Parameters
objan object to be checked

Definition at line 357 of file GrxBasePlugin.java.

◆ getElement()

Element com.generalrobotix.ui.GrxBasePlugin.getElement ( )
inline

get element

Returns
element

Definition at line 236 of file GrxBasePlugin.java.

◆ getField()

static Object com.generalrobotix.ui.GrxBasePlugin.getField ( Class<? extends GrxBasePlugin cls,
String  field,
Object  defaultValue 
)
inlinestatic

get field

Parameters
cls
field
defaultValue
Returns

Definition at line 399 of file GrxBasePlugin.java.

◆ getIcon()

Image com.generalrobotix.ui.GrxBasePlugin.getIcon ( )
inline

get icon

Returns
icon

Definition at line 287 of file GrxBasePlugin.java.

◆ getMenu()

Vector<Action> com.generalrobotix.ui.GrxBasePlugin.getMenu ( )
inline

get menu

Returns
menu

Definition at line 311 of file GrxBasePlugin.java.

◆ getMenuPath()

String [] com.generalrobotix.ui.GrxBasePlugin.getMenuPath ( )
inline

get menu path

Returns
menu path

Definition at line 349 of file GrxBasePlugin.java.

◆ getName()

final String com.generalrobotix.ui.GrxBasePlugin.getName ( void  )
inline

get name

Returns
name

Definition at line 199 of file GrxBasePlugin.java.

◆ getObserver()

ArrayList<GrxObserver> com.generalrobotix.ui.GrxBasePlugin.getObserver ( )
inline

Definition at line 499 of file GrxBasePlugin.java.

◆ getOldName()

String com.generalrobotix.ui.GrxBasePlugin.getOldName ( )
inline

Definition at line 211 of file GrxBasePlugin.java.

◆ getSubMenu()

Vector<MenuManager> com.generalrobotix.ui.GrxBasePlugin.getSubMenu ( )
inline

get subMenu

Returns
subMenu

Definition at line 319 of file GrxBasePlugin.java.

◆ getURL()

String com.generalrobotix.ui.GrxBasePlugin.getURL ( boolean  expand)
inline

get url

Parameters
expandif expand is true, expanded url is returned.
Returns
url

Definition at line 367 of file GrxBasePlugin.java.

◆ GetValueEditType()

ValueEditType com.generalrobotix.ui.GrxBasePlugin.GetValueEditType ( String  key)
inline

Return editing type of the key item.

Returns
ValueEditType

Definition at line 515 of file GrxBasePlugin.java.

◆ isExclusive()

boolean com.generalrobotix.ui.GrxBasePlugin.isExclusive ( )
inline

check whether this is exclusive or not

Returns
true if exclusive, false otherwise

Definition at line 268 of file GrxBasePlugin.java.

◆ isSelected()

boolean com.generalrobotix.ui.GrxBasePlugin.isSelected ( )
inline

check whether this is selected or not

Returns
true if selected, false otherwise

Definition at line 252 of file GrxBasePlugin.java.

◆ notifyObservers()

void com.generalrobotix.ui.GrxBasePlugin.notifyObservers ( Object...  arg)
inline

Definition at line 503 of file GrxBasePlugin.java.

◆ propertyChanged()

boolean com.generalrobotix.ui.GrxBasePlugin.propertyChanged ( String  property,
String  value 
)
inline

check validity of new value of property and update if valid

Parameters
propertyname of property
valuevalue of property
Returns
true if checked(even if value is not used), false otherwise

Definition at line 463 of file GrxBasePlugin.java.

◆ registerCORBA()

boolean com.generalrobotix.ui.GrxBasePlugin.registerCORBA ( )
inline

Definition at line 426 of file GrxBasePlugin.java.

◆ rename()

void com.generalrobotix.ui.GrxBasePlugin.rename ( String  newName)
inline

rename this item

Parameters
newNamenew name

Definition at line 388 of file GrxBasePlugin.java.

◆ restoreProperties()

void com.generalrobotix.ui.GrxBasePlugin.restoreProperties ( )
inline

restore properties. Called by menu item "restore Properties"

Definition at line 115 of file GrxBasePlugin.java.

◆ setDocument()

void com.generalrobotix.ui.GrxBasePlugin.setDocument ( Document  doc)
inline

set document

Parameters
docdocument

Definition at line 219 of file GrxBasePlugin.java.

◆ setElement()

void com.generalrobotix.ui.GrxBasePlugin.setElement ( Element  element)
inline

set element

Parameters
elementelement

Definition at line 227 of file GrxBasePlugin.java.

◆ setExclusive()

void com.generalrobotix.ui.GrxBasePlugin.setExclusive ( boolean  b)
inline

set exclusive flag

Parameters
bflag

Definition at line 260 of file GrxBasePlugin.java.

◆ setFocused()

void com.generalrobotix.ui.GrxBasePlugin.setFocused ( boolean  b)
inline

set/unset focus on this plugin

Parameters
btrue to focus, false to unfocus

Definition at line 488 of file GrxBasePlugin.java.

◆ setIcon()

void com.generalrobotix.ui.GrxBasePlugin.setIcon ( String  iconName)
inlineprotected

set icon

Parameters
iconNamename of icon

Definition at line 276 of file GrxBasePlugin.java.

◆ setMenuItem()

void com.generalrobotix.ui.GrxBasePlugin.setMenuItem ( Action  a)
inline

add a menu item

Parameters
anew menu item

Definition at line 295 of file GrxBasePlugin.java.

◆ setMenuPath()

void com.generalrobotix.ui.GrxBasePlugin.setMenuPath ( String []  path)
inlineprotected

set menu path

Parameters
pathmenu path

Definition at line 327 of file GrxBasePlugin.java.

◆ setName()

void com.generalrobotix.ui.GrxBasePlugin.setName ( String  name)
inline

set name

Parameters
namename

Definition at line 189 of file GrxBasePlugin.java.

◆ setProperty()

Object com.generalrobotix.ui.GrxBasePlugin.setProperty ( String  key,
String  value 
)
inline

set property value associated with a keyword

Parameters
keykeyword
valuevalue of property associated with a keyword

Definition at line 477 of file GrxBasePlugin.java.

◆ setSelected()

void com.generalrobotix.ui.GrxBasePlugin.setSelected ( boolean  b)
inline

set selected flag

Parameters
bflag

Definition at line 244 of file GrxBasePlugin.java.

◆ setSubMenu()

void com.generalrobotix.ui.GrxBasePlugin.setSubMenu ( MenuManager  m)
inline

add a submenu

Parameters
anew submenu

Definition at line 303 of file GrxBasePlugin.java.

◆ setURL()

void com.generalrobotix.ui.GrxBasePlugin.setURL ( String  url)
inline

set URL property

Parameters
urlURL to be set

Definition at line 378 of file GrxBasePlugin.java.

◆ shutdown()

void com.generalrobotix.ui.GrxBasePlugin.shutdown ( )
inline

Definition at line 412 of file GrxBasePlugin.java.

◆ storeProperties()

Element com.generalrobotix.ui.GrxBasePlugin.storeProperties ( )
inline

store properties

Returns

Definition at line 139 of file GrxBasePlugin.java.

◆ syncExec()

boolean com.generalrobotix.ui.GrxBasePlugin.syncExec ( Runnable  r)
inlineprotected

Transfer SWT UI thread.

Parameters
rRunnable instance
Returns
boolean Syncable current display

Definition at line 336 of file GrxBasePlugin.java.

◆ toString()

final String com.generalrobotix.ui.GrxBasePlugin.toString ( )
inline

convert to String. Currently, name is returned.

Returns
name

Definition at line 207 of file GrxBasePlugin.java.

◆ unregisterCORBA()

void com.generalrobotix.ui.GrxBasePlugin.unregisterCORBA ( )
inline

Definition at line 419 of file GrxBasePlugin.java.

Member Data Documentation

◆ booleanComboItem_

final String [] com.generalrobotix.ui.GrxBasePlugin.booleanComboItem_ = new String[] {"true", "false" }
staticprotected

Definition at line 73 of file GrxBasePlugin.java.

◆ doc_

Document com.generalrobotix.ui.GrxBasePlugin.doc_
protected

Definition at line 65 of file GrxBasePlugin.java.

◆ element_

Element com.generalrobotix.ui.GrxBasePlugin.element_
protected

Definition at line 66 of file GrxBasePlugin.java.

◆ iconName_

String com.generalrobotix.ui.GrxBasePlugin.iconName_
private

Definition at line 59 of file GrxBasePlugin.java.

◆ INDENT4

final String com.generalrobotix.ui.GrxBasePlugin.INDENT4 = " "
staticprotected

Definition at line 71 of file GrxBasePlugin.java.

◆ ireg_

ImageRegistry com.generalrobotix.ui.GrxBasePlugin.ireg_
private

Definition at line 58 of file GrxBasePlugin.java.

◆ isExclusive_

boolean com.generalrobotix.ui.GrxBasePlugin.isExclusive_ = false
private

Definition at line 56 of file GrxBasePlugin.java.

◆ ITEM_TAG

final String com.generalrobotix.ui.GrxBasePlugin.ITEM_TAG = "item"
staticprotected

Definition at line 68 of file GrxBasePlugin.java.

◆ manager_

GrxPluginManager com.generalrobotix.ui.GrxBasePlugin.manager_
protected

Definition at line 53 of file GrxBasePlugin.java.

◆ menu_

Vector<Action> com.generalrobotix.ui.GrxBasePlugin.menu_ = new Vector<Action>()
private

Definition at line 61 of file GrxBasePlugin.java.

◆ menuPath_

String [] com.generalrobotix.ui.GrxBasePlugin.menuPath_
private

Definition at line 63 of file GrxBasePlugin.java.

◆ name_

String com.generalrobotix.ui.GrxBasePlugin.name_
private

Definition at line 51 of file GrxBasePlugin.java.

◆ observers_

ArrayList<GrxObserver> com.generalrobotix.ui.GrxBasePlugin.observers_ = new ArrayList<GrxObserver>()
private

Definition at line 75 of file GrxBasePlugin.java.

◆ oldName_

String com.generalrobotix.ui.GrxBasePlugin.oldName_
private

Definition at line 52 of file GrxBasePlugin.java.

◆ PROPERTY_TAG

final String com.generalrobotix.ui.GrxBasePlugin.PROPERTY_TAG = "property"
staticprotected

Definition at line 70 of file GrxBasePlugin.java.

◆ selected_

boolean com.generalrobotix.ui.GrxBasePlugin.selected_ = true
private

Definition at line 55 of file GrxBasePlugin.java.

◆ subMenu_

Vector<MenuManager> com.generalrobotix.ui.GrxBasePlugin.subMenu_ = new Vector<MenuManager>()
private

Definition at line 62 of file GrxBasePlugin.java.

◆ url_

String com.generalrobotix.ui.GrxBasePlugin.url_
private

Definition at line 54 of file GrxBasePlugin.java.

◆ VIEW_TAG

final String com.generalrobotix.ui.GrxBasePlugin.VIEW_TAG = "view"
staticprotected

Definition at line 69 of file GrxBasePlugin.java.


The documentation for this class was generated from the following file:


openhrp3
Author(s): AIST, General Robotix Inc., Nakamura Lab of Dept. of Mechano Informatics at University of Tokyo
autogenerated on Thu Sep 8 2022 02:24:07