com.tssap.util.ui.reuse.java
Class ParameterComponent

java.lang.Object
  |
  +--com.tssap.util.ui.AbstractEditable
        |
        +--com.tssap.util.ui.reuse.GenericComponent
              |
              +--com.tssap.util.ui.reuse.ObjectEditorComponent
                    |
                    +--com.tssap.util.ui.reuse.DefaultObjectEditorComponent
                          |
                          +--com.tssap.util.ui.reuse.RefreshObjectEditorComponent
                                |
                                +--com.tssap.util.ui.reuse.java.JavaComponent
                                      |
                                      +--com.tssap.util.ui.reuse.java.ParameterComponent

All Implemented Interfaces:

IEditable, IGenericComponent, IGridLayoutPaneContainer, IObjectEditorComponent, IReuseable, IValidatable

Direct Known Subclasses:

FieldComponent

public class ParameterComponent

extends JavaComponent

Fields inherited from interface com.tssap.util.ui.reuse.java.IValidatable

STATUS_OK

Fields inherited from interface com.tssap.util.ui.reuse.IObjectEditorComponent

SEVERITY_PREFIX_ERROR, SEVERITY_PREFIX_INFO, SEVERITY_PREFIX_LEAVABLE_WARNING, SEVERITY_PREFIX_UNLEAVABLE_WARNING

Constructor Summary

ParameterComponent()
Constructor for ParameterComponent.

ParameterComponent(java.lang.String title)
Constructor for ParameterComponent.

Method Summary

java.lang.String	acceptData(java.lang.Object data) Method acceptData.
com.tssap.util.ui.reuse.java.IParameterCallback	getCallback() Returns the callback.
IParameterData	getParameterData()
org.eclipse.core.runtime.IStatus	getValidationStatus()
void	initContainer(IGridLayoutPane userArea) Initialize component's UI.
boolean	isModifiersEditable()
boolean	isModifiersVisible()
void	refreshDataFromUI() The implementation has to update the content of the data Object with the current UI inputs
void	refreshUIFromData() The implementation has to fill it's UI elements with the data contained in it's data Object The implementation can rely that @see #setData(Object) and @see IReuseable#createPartControl(Composite) have been called before this method is invoked
void	setCallback(com.tssap.util.ui.reuse.java.IParameterCallback callback) Sets the callback.
void	setModifiedCallback(IModifiedCallback callback) The @see IModifiedCallback has to be informed about the "dirty" status of the editor component.
void	setModifiersEditable(boolean modifiersEditable)
void	setModifiersVisible(boolean modifiersVisible)
void	setParameterData(IParameterData data)
void	setTypeChooser(IChooser typeChooser) Sets the typeChooser.

Methods inherited from class com.tssap.util.ui.reuse.java.JavaComponent

getJavaData, isAutoRefreshData, okToLeave, setAutoRefreshData, setJavaData

Methods inherited from class com.tssap.util.ui.reuse.DefaultObjectEditorComponent

getUserGridNumOfColumns, isUserGridEqualColSize

Methods inherited from class com.tssap.util.ui.reuse.ObjectEditorComponent

dispose, getData, getModifiedCallback, isDataAutoRefreshing, isEnabled, setData, setEnabled

Methods inherited from class com.tssap.util.ui.reuse.GenericComponent

addModifyListener, addSelectionListener, createPartControl, createPartControl, createPartControl, getTitle, getUserAreaGridLayoutPane, isComposable, refresh, removeModifyListener, removeSelectionListener, setTitle

Methods inherited from class com.tssap.util.ui.AbstractEditable

isEditable, setEditable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tssap.util.ui.reuse.IReuseable

createPartControl

Methods inherited from interface com.tssap.util.ui.IEditable

isEditable, setEditable

Constructor Detail

ParameterComponent

public ParameterComponent()

Constructor for ParameterComponent.

ParameterComponent

public ParameterComponent(java.lang.String title)

Constructor for ParameterComponent.

Parameters:

title -

Method Detail

initContainer

public void initContainer(IGridLayoutPane userArea)

Description copied from interface: IGridLayoutPaneContainer

Initialize component's UI. Implementor has to fill the given grid layout pane. The number of columns comes from call to method getUserGridNumOfColumns(). If grid columns have equal widths is decided through call to isUserGridEqualColSize().

See Also:

IGridLayoutPaneContainer.initContainer(com.tssap.util.ui.pane.IGridLayoutPane)

refreshDataFromUI

public void refreshDataFromUI()

Description copied from interface: IObjectEditorComponent

The implementation has to update the content of the data Object with the current UI inputs

Overrides:

refreshDataFromUI in class JavaComponent

See Also:

IObjectEditorComponent.refreshDataFromUI()

refreshUIFromData

public void refreshUIFromData()

Description copied from interface: IObjectEditorComponent

The implementation has to fill it's UI elements with the data contained in it's data Object The implementation can rely that @see #setData(Object) and @see IReuseable#createPartControl(Composite) have been called before this method is invoked

Overrides:

refreshUIFromData in class JavaComponent

See Also:

IObjectEditorComponent.refreshUIFromData()

getParameterData

public IParameterData getParameterData()

setParameterData

public void setParameterData(IParameterData data)

acceptData

public java.lang.String acceptData(java.lang.Object data)

Description copied from class: ObjectEditorComponent

Method acceptData.

Overrides:

acceptData in class JavaComponent

See Also:

ObjectEditorComponent.acceptData(java.lang.Object)

setModifiedCallback

public void setModifiedCallback(IModifiedCallback callback)

Description copied from interface: IObjectEditorComponent

The @see IModifiedCallback has to be informed about the "dirty" status of the editor component. A editor component has to inform the Callback when the UI user changes any UI content so that a call of

Overrides:

setModifiedCallback in class ObjectEditorComponent

See Also:

IObjectEditorComponent.setModifiedCallback(com.tssap.util.ui.reuse.IModifiedCallback)

getValidationStatus

public org.eclipse.core.runtime.IStatus getValidationStatus()

Overrides:

getValidationStatus in class JavaComponent

Following copied from class: com.tssap.util.ui.reuse.java.JavaComponent

See Also:

IValidatable.getValidationStatus()

setTypeChooser

public void setTypeChooser(IChooser typeChooser)

Sets the typeChooser.

Parameters:

typeChooser - The typeChooser to set

getCallback

public com.tssap.util.ui.reuse.java.IParameterCallback getCallback()

Returns the callback.

Returns:

IParameterCallback

setCallback

public void setCallback(com.tssap.util.ui.reuse.java.IParameterCallback callback)

Sets the callback.

Parameters:

callback - The callback to set

isModifiersEditable

public boolean isModifiersEditable()

Returns:

isModifiersVisible

public boolean isModifiersVisible()

Returns:

setModifiersEditable

public void setModifiersEditable(boolean modifiersEditable)

Parameters:

modifiersEditable -

setModifiersVisible

public void setModifiersVisible(boolean modifiersVisible)

Parameters:

modifiersVisible -