Inheritance diagram for com.generalrobotix.ui.GrxBasePlugin:

Classes
class	ValueEditCombo
class	ValueEditText
class	ValueEditType
Public Member Functions
void	addObserver (GrxObserver v)
GrxBasePlugin	clone ()
	Override clone method.
void	deleteObserver (GrxObserver v)
boolean	equals (Object obj)
	check whether obj equals to this
Element	getElement ()
	get element
Image	getIcon ()
	get icon
Vector< Action >	getMenu ()
	get menu
String[]	getMenuPath ()
	get menu path
final String	getName ()
	get name
ArrayList< GrxObserver >	getObserver ()
String	getOldName ()
Vector< MenuManager >	getSubMenu ()
	get subMenu
String	getURL (boolean expand)
ValueEditType	GetValueEditType (String key)
	Return editing type of the key item.
boolean	isExclusive ()
	check whether this is exclusive or not
boolean	isSelected ()
	check whether this is selected or not
void	notifyObservers (Object...arg)
boolean	propertyChanged (String property, String value)
	check validity of new value of property and update if valid
boolean	registerCORBA ()
void	rename (String newName)
	rename this item
void	restoreProperties ()
	restore properties. Called by menu item "restore Properties"
void	setDocument (Document doc)
	set document
void	setElement (Element element)
	set element
void	setExclusive (boolean b)
	set exclusive flag
void	setFocused (boolean b)
	set/unset focus on this plugin
void	setMenuItem (Action a)
	add a menu item
void	setName (String name)
	set name
Object	setProperty (String key, String value)
	set property value associated with a keyword
void	setSelected (boolean b)
	set selected flag
void	setSubMenu (MenuManager m)
	add a submenu
void	setURL (String url)
	set URL property
void	shutdown ()
Element	storeProperties ()
	store properties
final String	toString ()
	convert to String. Currently, name is returned.
void	unregisterCORBA ()
Static Public Member Functions
static Object	getField (Class<?extends GrxBasePlugin > cls, String field, Object defaultValue)
	get field
Protected Member Functions
	GrxBasePlugin (String name, GrxPluginManager manager)
	constructor
void	setIcon (String iconName)
	set icon
void	setMenuPath (String[] path)
	set menu path
boolean	syncExec (Runnable r)
	Transfer SWT UI thread.
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< GrxObserver >	observers_ = 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

com.generalrobotix.ui.GrxBasePlugin.GrxBasePlugin	(	String	name,
		GrxPluginManager	manager
	)		`[inline, protected]`

constructor

Parameters:

name	name of this plugin
manager	plugin manager

Definition at line 82 of file GrxBasePlugin.java.

Member Function Documentation

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

Definition at line 491 of file GrxBasePlugin.java.

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

Override clone method.

Returns:: GrxBasePlugin

Reimplemented in com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.item.GrxShapeItem, com.generalrobotix.ui.item.GrxLinkItem, com.generalrobotix.ui.item.GrxSensorItem, and com.generalrobotix.ui.GrxBaseItem.

Definition at line 434 of file GrxBasePlugin.java.

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

Definition at line 495 of file GrxBasePlugin.java.

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

check whether obj equals to this

Parameters:

obj	an object to be checked

Definition at line 357 of file GrxBasePlugin.java.

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

get element

Returns:: element

Definition at line 236 of file GrxBasePlugin.java.

static Object com.generalrobotix.ui.GrxBasePlugin.getField	(	Class<?extends GrxBasePlugin >	cls,
		String	field,
		Object	defaultValue
	)		`[inline, static]`

get field

Parameters:

cls
field
defaultValue

Returns:

Definition at line 399 of file GrxBasePlugin.java.

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

get icon

Returns:: icon

Definition at line 287 of file GrxBasePlugin.java.

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

get menu

Returns:: menu

Reimplemented in com.generalrobotix.ui.item.GrxProjectItem.

Definition at line 311 of file GrxBasePlugin.java.

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

get menu path

Returns:: menu path

Reimplemented in com.generalrobotix.ui.view.GrxProcessManagerView.

Definition at line 349 of file GrxBasePlugin.java.

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

get name

Returns:: name

Definition at line 199 of file GrxBasePlugin.java.

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

Definition at line 499 of file GrxBasePlugin.java.

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

Definition at line 211 of file GrxBasePlugin.java.

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

get subMenu

Returns:: subMenu

Definition at line 319 of file GrxBasePlugin.java.

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

get url

Parameters:

expand if expand is true, expanded url is returned.

Returns:: url

Definition at line 367 of file GrxBasePlugin.java.

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

Return editing type of the key item.

Returns:: ValueEditType

Reimplemented in com.generalrobotix.ui.view.Grx3DView, com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.item.GrxShapeItem, com.generalrobotix.ui.item.GrxLinkItem, com.generalrobotix.ui.item.GrxSimulationItem, com.generalrobotix.ui.item.GrxSensorItem, and com.generalrobotix.ui.item.GrxExtraJointItem.

Definition at line 515 of file GrxBasePlugin.java.

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.

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.

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

Definition at line 503 of file GrxBasePlugin.java.

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

check validity of new value of property and update if valid

Parameters:

property	name of property
value	value of property

Returns:: true if checked(even if value is not used), false otherwise

Reimplemented in com.generalrobotix.ui.view.Grx3DView, com.generalrobotix.ui.item.GrxShapeItem, com.generalrobotix.ui.item.GrxLinkItem, com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.view.GrxRobotStatView, com.generalrobotix.ui.item.GrxSensorItem, com.generalrobotix.ui.item.GrxExtraJointItem, com.generalrobotix.ui.item.GrxPathPlanningAlgorithmItem, and com.generalrobotix.ui.item.GrxSegmentItem.

Definition at line 463 of file GrxBasePlugin.java.

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

Reimplemented in com.generalrobotix.ui.view.Grx3DView, com.generalrobotix.ui.item.GrxSimulationItem, and com.generalrobotix.ui.view.GrxOpenHRPView.

Definition at line 426 of file GrxBasePlugin.java.

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

rename this item

Parameters:

newName new name

Reimplemented in com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.item.GrxLinkItem, com.generalrobotix.ui.item.GrxShapeTransformItem, com.generalrobotix.ui.item.GrxWorldStateItem, and com.generalrobotix.ui.item.GrxTextItem.

Definition at line 388 of file GrxBasePlugin.java.

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

restore properties. Called by menu item "restore Properties"

Reimplemented in com.generalrobotix.ui.item.GrxSimulationItem, com.generalrobotix.ui.view.Grx3DView, com.generalrobotix.ui.view.GrxLoggerView, com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.item.GrxWorldStateItem, com.generalrobotix.ui.GrxBaseView, com.generalrobotix.ui.item.GrxModeInfoItem, and com.generalrobotix.ui.item.GrxGraphItem.

Definition at line 115 of file GrxBasePlugin.java.

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

set document

Parameters:

doc document

Definition at line 219 of file GrxBasePlugin.java.

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

set element

Parameters:

element element

Definition at line 227 of file GrxBasePlugin.java.

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

set exclusive flag

Parameters:

b flag

Definition at line 260 of file GrxBasePlugin.java.

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

set/unset focus on this plugin

Parameters:

b	true to focus, false to unfocus

Reimplemented in com.generalrobotix.ui.item.GrxModelItem, com.generalrobotix.ui.item.GrxLinkItem, com.generalrobotix.ui.item.GrxSensorItem, com.generalrobotix.ui.item.GrxTransformItem, and com.generalrobotix.ui.item.GrxSegmentItem.

Definition at line 488 of file GrxBasePlugin.java.

void com.generalrobotix.ui.GrxBasePlugin.setIcon ( String iconName ) [inline, protected]

set icon

Parameters:

iconName name of icon

Definition at line 276 of file GrxBasePlugin.java.

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

add a menu item

Parameters:

a	new menu item

Definition at line 295 of file GrxBasePlugin.java.

void com.generalrobotix.ui.GrxBasePlugin.setMenuPath ( String[] path ) [inline, protected]

set menu path

Parameters:

path menu path

Definition at line 327 of file GrxBasePlugin.java.

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

set name

Parameters:

name name

Reimplemented in com.generalrobotix.ui.GrxBaseView.

Definition at line 189 of file GrxBasePlugin.java.

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

set property value associated with a keyword

Parameters:

key	keyword
value	value of property associated with a keyword

Definition at line 477 of file GrxBasePlugin.java.

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

set selected flag

Parameters:

b flag

Reimplemented in com.generalrobotix.ui.item.GrxModelItem.

Definition at line 244 of file GrxBasePlugin.java.

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

add a submenu

Parameters:

a	new submenu

Definition at line 303 of file GrxBasePlugin.java.

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

set URL property

Parameters:

url	URL to be set

Definition at line 378 of file GrxBasePlugin.java.

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

Definition at line 412 of file GrxBasePlugin.java.

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

store properties

Returns:

Reimplemented in com.generalrobotix.ui.GrxBaseView.

Definition at line 139 of file GrxBasePlugin.java.

boolean com.generalrobotix.ui.GrxBasePlugin.syncExec ( Runnable r ) [inline, protected]

Transfer SWT UI thread.

Parameters:

r	Runnable instance

Returns:: boolean Syncable current display

Definition at line 336 of file GrxBasePlugin.java.

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.

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

Reimplemented in com.generalrobotix.ui.view.Grx3DView, com.generalrobotix.ui.item.GrxSimulationItem, and com.generalrobotix.ui.view.GrxOpenHRPView.

Definition at line 419 of file GrxBasePlugin.java.

Member Data Documentation

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

Definition at line 73 of file GrxBasePlugin.java.

Document com.generalrobotix.ui.GrxBasePlugin.doc_ [protected]

Reimplemented in com.generalrobotix.ui.item.GrxProjectItem.

Definition at line 65 of file GrxBasePlugin.java.

Element com.generalrobotix.ui.GrxBasePlugin.element_ [protected]

Definition at line 66 of file GrxBasePlugin.java.

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

Definition at line 59 of file GrxBasePlugin.java.

final String com.generalrobotix.ui.GrxBasePlugin.INDENT4 = " " [static, protected]

Definition at line 71 of file GrxBasePlugin.java.

ImageRegistry com.generalrobotix.ui.GrxBasePlugin.ireg_ [private]

Definition at line 58 of file GrxBasePlugin.java.

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

Definition at line 56 of file GrxBasePlugin.java.

final String com.generalrobotix.ui.GrxBasePlugin.ITEM_TAG = "item" [static, protected]

Definition at line 68 of file GrxBasePlugin.java.

GrxPluginManager com.generalrobotix.ui.GrxBasePlugin.manager_ [protected]

Definition at line 53 of file GrxBasePlugin.java.

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

Reimplemented in com.generalrobotix.ui.item.GrxProjectItem.

Definition at line 61 of file GrxBasePlugin.java.

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

Definition at line 63 of file GrxBasePlugin.java.

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

Definition at line 51 of file GrxBasePlugin.java.

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

Definition at line 75 of file GrxBasePlugin.java.

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

Definition at line 52 of file GrxBasePlugin.java.

final String com.generalrobotix.ui.GrxBasePlugin.PROPERTY_TAG = "property" [static, protected]

Definition at line 70 of file GrxBasePlugin.java.

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

Definition at line 55 of file GrxBasePlugin.java.

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

Definition at line 62 of file GrxBasePlugin.java.

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

Definition at line 54 of file GrxBasePlugin.java.

final String com.generalrobotix.ui.GrxBasePlugin.VIEW_TAG = "view" [static, protected]

Definition at line 69 of file GrxBasePlugin.java.

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

GrxBasePlugin.java

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation