Package com.iizigo.panel.prop

Interface IEUIPanel

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IClassReferenceOwner, IComponent, ICustomDataProvider, IEImagePreview, IEUICompBase, IEUICompCommon, IEUIContainer, IExtendsSelection, IGProp<GProp<?>[]>, IJavaClassLinkEnabler, IJavaMethodLinkEnabler, ILinkCapable, IMessageBox, IPropCnr, IPropDesigner, IPropRenameable, IPropUndoContext, IStylesFilter, ITransferContainerProps, IUIBuilderFromVSLinkEnabler, IUIComp, IUIComponentLinkEnabler, IUIContainer, IVSComponentListener, IVSComponentState, IVSFieldListener, IVSLinkEnabler, IVSParticipantLinkEnabler

All Known Implementing Classes:

EMUISimpleDialog, EUIDialog, EUIPanel, EUIPanelPart

public interface IEUIPanel
extends IEUIContainer, IPropUndoContext, IJavaClassLinkEnabler, IVSParticipantLinkEnabler

Interface implemented by panels in the Designer.

Author:

Christopher Mindus

Nested Class Summary

Nested classes/interfaces inherited from interface com.iizix.gyro.IMessageBox

IMessageBox.Icon

Nested classes/interfaces inherited from interface com.iizix.prop.vs.IVSComponentState

IVSComponentState.State

Field Summary

Fields

Modifier and Type	Field	Description
static AnnotationType[]	PANEL_METHOD_LINK_ANNOTATIONS	Linkable methods.

Fields inherited from interface com.iizix.prop.IGProp

EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Fields inherited from interface com.iizigo.link.ILinkCapable

STATUS_LINK_NOT_SUPPORTED

Fields inherited from interface com.iizix.gyro.IMessageBox

ICON_ERROR, ICON_INFORMATION, ICON_MAP, ICON_NONE, ICON_QUESTION, ICON_WARNING

Fields inherited from interface com.iizix.prop.ui.IUIComp

ERROR, INFORMATION, NONE, REMOTE_FOCUS_EVENT, WARNING

Fields inherited from interface com.iizigo.vs.link.IVSLinkEnabler

EMPTY_VSLINK_INFO, OPERATION_CANCELED

Fields inherited from interface com.iizigo.vs.link.IVSParticipantLinkEnabler

VIRTUALSPACE_PARTICIPANT_LINK_ENABLER

Method Summary

Modifier and Type	Method	Description
default boolean	canRenameProperty()	Checks if the property can be renamed.
EPanelData	createLayout()	Create the layout property.
EditorClassReference	getClassReference(java.lang.String id, boolean doCreateIfNotPresent)	Gets or creates the ClassReference in the property container.
default EditorClassReference	getClassReferenceImpl(java.lang.String id, boolean doCreateIfNotPresent)	Gets or creates the ClassReference in the property container.
default java.util.Collection<ILinkOperation>	getLinkOperations(LinkData data)	Called when the drag-drop is to be performed (link or paste-link menu item).
default AnnotationType[]	getMethodReferenceAnnotationTypes()	Returns the annotation types for the method reference(s).
default org.eclipse.core.runtime.IStatus	isLinkCapable(LinkData data)	Returns if this property container could potentially be link capable.

Methods inherited from interface com.iizix.prop.IClassReferenceOwner

getClassReferenceAtom, getClassReferenceImplementsInterface, getClassReferenceRequiredAnnotation, getRuntimeClassInstance, getRuntimeClassInstance, isClassReferenceAnnotationBackReferenceRequired

Methods inherited from interface com.iizix.IComponent

clearErrorMessage, getBadge, getKStringText, getLayoutMgr, getMessage, getMessageText, getStyles, getText, getTooltip, getTooltipText, getUIPanel, getUIParent, isEnabled, isReadOnly, isVisible, messageBox, requestFocus, requestFocus, requestFocusEx, requestFocusEx, setBadge, setBadge, setEnabled, setErrorMessage, setErrorMessage, setHTMLText, setLayoutMgr, setMessage, setMessage, setReadOnly, setText, setText, setTooltip, setTooltip, setVisible

Methods inherited from interface com.iizix.prop.ICustomDataProvider

forbiddenGetCustomDataMap, getCustomData, putCustomData, putCustomDataIfAbsent

Methods inherited from interface com.iizigo.panel.prop.IEImagePreview

getImagePreview

Methods inherited from interface com.iizigo.panel.prop.IEUICompBase

getCNDescriptionType, getCNImage, getPossibleContainerParents, isValidContainer

Methods inherited from interface com.iizigo.panel.prop.IEUICompCommon

canMark, getBounds, getEditorPropCnr, getParentClientBounds, useCNPropID

Methods inherited from interface com.iizigo.panel.prop.IEUIContainer

addPredefinedPropsImpl, canContainComponent, createCompsCnr, createStyles, getAcceptedLayoutMgrs, getClientBounds, getDesigner, getPossibleCompChildren, getPredefinedProps

Methods inherited from interface com.iizigo.prop.editor.IExtendsSelection

getSelectPropDialogTitle, getSelectPropViewerFilter

Methods inherited from interface com.iizix.prop.IGProp

addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getParent, getParent, getPropAtom, getPropBaseReference, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getReferences, getRelativePropName, getRootParent, getTreeLock, getValueClasses, getVSReference, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCommunicating, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPropTreeInitialized, onRemoteEvent, removePropError, removePropListener, renameProp, resolveRuntimeReferences, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toElementString, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, validatePropType, validatePropValue, verify, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizigo.link.java.IJavaClassLinkEnabler

addClassLinkOperations, isClassLinkCapable

Methods inherited from interface com.iizigo.link.java.IJavaMethodLinkEnabler

addMethodLinkOperations, isMethodLinkCapable

Methods inherited from interface com.iizigo.link.ILinkCapable

getDragDropHTML

Methods inherited from interface com.iizix.gyro.IMessageBox

messageBox, messageBox

Methods inherited from interface com.iizix.prop.IPropCnr

addProp, addProp, addProp2, addProp2, canRequestFocus, canRequestFocus, canRequestFocus, containsProp, containsProp, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, enablePropCommunication, enablePropHashMap, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsError, getExtendsName, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropCnr, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getString, getString, getString, getString, hasFocus, initializeExtendsFramework, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsRoot, isPropAddRemoveAllowed, isPropExtended, isSibling, removeAllProps, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, requestFocus, requestFocusEx, setBool, setBool, setBool, setBool, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, usePropHashMap, usesPropIndex, validateClassInstances

Methods inherited from interface com.iizigo.prop.IPropDesigner

findIResource, getAdapter

Methods inherited from interface com.iizigo.prop.IPropUndoContext

getUndoContext

Methods inherited from interface com.iizigo.style.prop.IStylesFilter

getStylesName, getSupportedStyles

Methods inherited from interface com.iizigo.prop.ITransferContainerProps

canPasteFrom, canPasteTo, getCNDescriptionType, getTransferProps, transferContainerProps

Methods inherited from interface com.iizigo.link.ui.IUIBuilderFromVSLinkEnabler

addUIBuilderFromVSLinkOperations, getDragDropText, getUIPanel, isUIBuilderFromVSLinkCapable

Methods inherited from interface com.iizix.prop.ui.IUIComp

canAcceptUIContainerFocus, disconnectVSField, getComponentID, getComponentMappings, getDeviceType, getErrorMessage, getErrorMessage, getFirstUIComponent, getFirstUIComponentNull, getFixHeight, getFixWidth, getLayout, getLayoutMgr, getPanelUIComponent, getPanelUIComponentNull, getUIRef, getValue, getValue, getVirtualSpace, getVSField, isMobile, isRTL, isVSFieldDisconnected, reconnectVSField, setComponentToVSField, setErrorMessage, setErrorMessage, setUIContainerFocus, setVSFieldMessageToComponent, setVSFieldToComponent

Methods inherited from interface com.iizigo.link.ui.IUIComponentLinkEnabler

getJavaClassLinkEnabler, getRelativeMethodAnnotationReference, getUIComponentLinkOperations, getUIPanel, isUIComponentLinkCapable

Methods inherited from interface com.iizix.prop.ui.IUIContainer

getComponentCount, getComponents, getCompsCnr, getRadioSelectionComponents, getSelectedRadioComponent, setRadioSelectionComponent

Methods inherited from interface com.iizix.prop.vs.IVSComponentListener

onParentStateChanged

Methods inherited from interface com.iizix.prop.vs.IVSFieldListener

getBestVSFieldValueType, onBroken, onResolved, onStateChanged, onValueChanged

Methods inherited from interface com.iizigo.vs.link.IVSLinkEnabler

attempVSLink

Methods inherited from interface com.iizigo.vs.link.IVSParticipantLinkEnabler

getVSLinkInfo

Field Detail

PANEL_METHOD_LINK_ANNOTATIONS

static final AnnotationType[] PANEL_METHOD_LINK_ANNOTATIONS

Linkable methods.

Method Detail

getClassReference

EditorClassReference getClassReference(java.lang.String id,
                                       boolean doCreateIfNotPresent)

Gets or creates the ClassReference in the property container.

Panel do not use "ID" because there is a single class connection with the name Atom.CLASS.

Specified by:

getClassReference in interface IClassReferenceOwner

Specified by:

getClassReference in interface IJavaClassLinkEnabler

Parameters:

id - ID for the class reference if several exist, null for default.

doCreateIfNotPresent - Flag to create the property (this flag can only be true in Designer)!

Returns:

The resolved class reference instance, null if the ClassReference doesn't exist if the create flag is false. If flag is true, an orphan unresolved EditorClassReference instance (ONLY for the Designer).

getClassReferenceImpl

default EditorClassReference getClassReferenceImpl(java.lang.String id,
                                                   boolean doCreateIfNotPresent)

Gets or creates the ClassReference in the property container.

Panel do not use "ID" because there is a single class connection with the name Atom.CLASS.

Parameters:

id - ID for the class reference if several exist, null for default.

doCreateIfNotPresent - Flag to create the property (this flag can only be true in Designer)!

Returns:

The resolved class reference instance, null if the ClassReference doesn't exist if the create flag is false. If flag is true, an orphan unresolved EditorClassReference instance (ONLY for the Designer).

canRenameProperty

default boolean canRenameProperty()

Checks if the property can be renamed.

Specified by:

canRenameProperty in interface IPropRenameable

Returns:

true for OK, false for failure.

getMethodReferenceAnnotationTypes

default AnnotationType[] getMethodReferenceAnnotationTypes()

Returns the annotation types for the method reference(s).

Specified by:

getMethodReferenceAnnotationTypes in interface IJavaMethodLinkEnabler

Returns:

An array with the annotations supported.

isLinkCapable

default org.eclipse.core.runtime.IStatus isLinkCapable(LinkData data)

Returns if this property container could potentially be link capable.

This call is done many times during drag-drop and must be very fast and not cause too much garbage collection.

Specified by:

isLinkCapable in interface IEUIContainer

Specified by:

isLinkCapable in interface IJavaClassLinkEnabler

Specified by:

isLinkCapable in interface IJavaMethodLinkEnabler

Specified by:

isLinkCapable in interface ILinkCapable

Specified by:

isLinkCapable in interface IUIBuilderFromVSLinkEnabler

Parameters:

data - The link data.

Returns:

The status of capability of the operation.

getLinkOperations

default java.util.Collection<ILinkOperation> getLinkOperations(LinkData data)

Called when the drag-drop is to be performed (link or paste-link menu item). The link-capable instance fills in only what it handles.

Specified by:

getLinkOperations in interface IEUIContainer

Specified by:

getLinkOperations in interface IJavaClassLinkEnabler

Specified by:

getLinkOperations in interface IJavaMethodLinkEnabler

Specified by:

getLinkOperations in interface ILinkCapable

Specified by:

getLinkOperations in interface IUIBuilderFromVSLinkEnabler

Parameters:

data - The link data.

Returns:

The list of operations required.

createLayout

EPanelData createLayout()

Create the layout property.

Returns:

A new instance of EPanelData named Atom.LAYOUT.