com.iizigo.prop.editor

Class VSTableColumnReferencePropEditor

java.lang.Object

com.iizigo.prop.BaseEditor<VSRelativeReference<?>,String>

com.iizigo.prop.editor.VSTableColumnReferencePropEditor

All Implemented Interfaces:

IEditedPropControllerOwner<VSRelativeReference<?>,String>, IEditedPropertyEntry<VSRelativeReference<?>,String>, IEditedPropertyEntryMultiProp<VSRelativeReference<?>,String>, IPropertyDefined

public class VSTableColumnReferencePropEditor
extends BaseEditor<VSRelativeReference<?>,String>

The VirtualSpace Reference property editor consists of a simple entry field and a more button to perform a selection.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>[]	classes
protected Image	image
protected String	itemDefined
protected IzMenu	menu
protected IzMenuItem	miGoto
protected IzMenuItem	miSelect
protected String	moreText
protected IzToolTip	tip
protected String	title
protected String	tooltipText

Fields inherited from class com.iizigo.prop.BaseEditor

appUI, combo, control, controller, definedButton, display, editor, focusListener, hasBeenModified, info, more, multipleValueWarningInput, options, parent, propController, shell, text, validator, wasDefinedAtFocusGained

Constructor Summary

Constructors

Constructor and Description
VSTableColumnReferencePropEditor() Default constructor called before createControls.

Method Summary

Modifier and Type	Method and Description
protected void	create() Creates the property editor controls.
String	formatValue(String value) Formats the value for user input as a String.
protected VSColumnHeader	getCurrentReferenceTarget() Gets the current property reference target.
String	getDefaultValue() Gets the default defined value to set in the property when defined.
protected VSColumnHeader	getReferenceTarget(String columnName) Gets the current property reference target.
protected String	getToolTipText() Gets the tooltip text to display in the entry fields (not the one for property errors or validator).
protected String	getValue(String input) Gets the property value for a user input.
protected EditorVirtualSpace	getVirtualSpace(int ask) Gets the VirtualSpace, prompted to create it perhaps, or connect.
protected void	onCreateMenu(IzMenu menu, boolean isPost) Called to create the menu items.
protected void	onDoubleClick(Event e) Called when mouse is double-clicked in the text or combobox.
protected boolean	onGoto(boolean doPerform) Goto reference.
protected boolean	onList(boolean doPerform) Called when the "more..." button is pressed.
void	onMore() Called when the "more..." button is pressed.
protected void	setToolTipText(String msg) Sets the tooltip text.
protected void	setup() Override to provide user settings.

Methods inherited from class com.iizigo.prop.BaseEditor

assignMaster, beginProcessEvent, canProcessEvents, checkInput, createCCombo, createControls, createGridLayout, createIzMenu, createMoreButton, createMoreIzMenu, createText, dispose, doUndefineIfEmpty, doValueChangeConversion, endProcessEvent, getBaseEditor, getCurrentInput, getCurrentValue, getCurrentValues, getModifyListener, getNativeToolTip, getOption, getSelectionListener, getSeverity, getShell, getToolTipText2, hasFocus, initialize, isPropReadOnly, onDefine, onDispose, onError, onF4List, onFocusGained, onFocusLost, onReadOnly, onUndefined, onUpdate, setColors, setCurrentValue, setEditable, setFocus, setInput, setInputValue, setInputValueFromProp, showMenu, updateTooltip, validate

Methods inherited from class java.lang.Object

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

Field Detail

title

protected String title

moreText

protected String moreText

tooltipText

protected String tooltipText

itemDefined

protected String itemDefined

image

protected Image image

classes

protected Class<?>[] classes

tip

protected IzToolTip tip

menu

protected IzMenu menu

miSelect

protected IzMenuItem miSelect

miGoto

protected IzMenuItem miGoto

Constructor Detail

VSTableColumnReferencePropEditor

public VSTableColumnReferencePropEditor()

Default constructor called before createControls.

Method Detail

setup

protected void setup()

Override to provide user settings.

create

protected void create()

Creates the property editor controls.

Specified by:

create in class BaseEditor<VSRelativeReference<?>,String>

getVirtualSpace

protected EditorVirtualSpace getVirtualSpace(int ask)

Gets the VirtualSpace, prompted to create it perhaps, or connect.

Parameters:

ask - Question when -1, to connect or create, 0=connect, 1=create.

Returns:

null if canceled.

onCreateMenu

protected void onCreateMenu(IzMenu menu,
                            boolean isPost)

Called to create the menu items.

onDoubleClick

protected void onDoubleClick(Event e)

Called when mouse is double-clicked in the text or combobox. Overridden to check if Goto reference is enabled, and if so goes there.

Overrides:

onDoubleClick in class BaseEditor<VSRelativeReference<?>,String>

onMore

public void onMore()

Called when the "more..." button is pressed. Override to display dialog box.

Overrides:

onMore in class BaseEditor<VSRelativeReference<?>,String>

onList

protected boolean onList(boolean doPerform)

Called when the "more..." button is pressed. Override to display dialog box.

onGoto

protected boolean onGoto(boolean doPerform)

Goto reference.

getCurrentReferenceTarget

protected VSColumnHeader getCurrentReferenceTarget()

Gets the current property reference target. This reference is retrieved from the current input. If the path contains "Module:/", it is assumed to be a hard path. Otherwise the getBaseReferencePath() is prepended.

getReferenceTarget

protected VSColumnHeader getReferenceTarget(String columnName)

Gets the current property reference target. This reference is retrieved from the current input. If the path contains "Module:/", it is assumed to be a hard path. Otherwise the getBaseReferencePath() is prepended.

getToolTipText

protected String getToolTipText()

Gets the tooltip text to display in the entry fields (not the one for property errors or validator).

Specified by:

getToolTipText in class BaseEditor<VSRelativeReference<?>,String>

setToolTipText

protected void setToolTipText(String msg)

Sets the tooltip text. The default is to apply the getToolTipText() text to the edit control.

An attempt to show the tooltip of the reference target's DesignerProp tooltip is done.

Overrides:

setToolTipText in class BaseEditor<VSRelativeReference<?>,String>

Parameters:

msg - Message in tooltip (normally error), null for none, in which case the getToolTipText2() is used.

getDefaultValue

public String getDefaultValue()

Gets the default defined value to set in the property when defined.

Specified by:

getDefaultValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,String>

Specified by:

getDefaultValue in class BaseEditor<VSRelativeReference<?>,String>

getValue

protected String getValue(String input)

Gets the property value for a user input.

Specified by:

getValue in class BaseEditor<VSRelativeReference<?>,String>

Parameters:

input - The current user input.

Returns:

The property value for the input, or null to un-define the property.

formatValue

public String formatValue(String value)

Formats the value for user input as a String.

Specified by:

formatValue in interface IEditedPropControllerOwner<VSRelativeReference<?>,String>

Specified by:

formatValue in class BaseEditor<VSRelativeReference<?>,String>

Parameters:

value - The value.

Returns:

The formatted value.