Package com.iizigo.vs.prop
Class VirtualSpaceDesignerProp
- java.lang.Object
- com.iizigo.prop.DesignerProp
- com.iizigo.vs.prop.VirtualSpaceDesignerProp
 
 
- All Implemented Interfaces:
- INavigatorPresentation,- EventListener,- org.eclipse.core.runtime.IAdaptable
 - public class VirtualSpaceDesignerProp extends DesignerProp Class for the EditorScreenProp in the designer.- Author:
- Christopher Mindus
 
- Field Summary- Fields inherited from class com.iizigo.prop.DesignerProp- DESIGNER_PROPERTY, isFolder, isRoot, moveDownProperty, moveUpProperty, OP_COPY, OP_DELETE, OP_MOVE, propertyContainer
 - Fields inherited from interface com.iizigo.navigator.INavigatorPresentation- CN_PREFERENCE_FLAGS_NAME, DEFAULT_COMPARATOR, EMPTY_ARRAY, FLAG_ADD_FILE_ITEM_PACKAGE_LOCATION, FLAG_ADD_FILE_ITEM_PROJECT, FLAG_ADD_FOLDER_PACKAGE_LOCATION, FLAG_ADD_FOLDER_PROJECT, FLAG_CUSTOM_1, FLAG_CUSTOM_2, FLAG_CUSTOM_3, FLAG_JAVA_SUPPORT, FLAG_PACKAGE_VIEW, FLAG_SHOW_DESIGNER_PROPERTIES, FLAG_SHOW_EMPTY_MODULE_FOLDERS, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_SUBPROPERTIES, FLAGS_NORMAL, FLAGS_ONLY_FOLDERS
 
 - Constructor Summary- Constructors - Constructor - Description - VirtualSpaceDesignerProp(PropCnr propertyContainer)The constructor.
 - Method Summary- All Methods Instance Methods Concrete Methods - Modifier and Type - Method - Description - java.lang.String- canPerform(int operation)Checks if an operation on this property is permitted.- org.eclipse.swt.widgets.Composite- createCNToolTip(org.eclipse.swt.widgets.Event event, org.eclipse.jface.viewers.ViewerCell cell, org.eclipse.swt.widgets.Composite parent)Requests creates of the Composite used to show the tooltip.- protected org.eclipse.swt.graphics.Color- getCNBackground0(GProp<?> property, int columnIndex, int flags)Provides a background color for the given element at the specified index.- int- getCNCategory()Gets the category of this Common Navigator object, used for sorting.- java.lang.Object[]- getCNChildren(int flags)Gets the children of this container for Common Navigator.- IViewerComparator- getCNComparator()Gets the comparator.- java.lang.String- getCNDescriptionType()Provide a type description for the status bar view, if available.- protected org.eclipse.swt.graphics.Color- getCNForeground0(GProp<?> property, int columnIndex, int flags)Provides a foreground color for the given element.- org.eclipse.swt.graphics.Image- getCNImage(int flags)Gets the image for the Common Navigator.- java.lang.Object- getCNParent(int flags)Gets the parent for Common Navigator.- DesignerProp- getCNRealProp()Gets the "real" property when the DesignerProp has been retrieved from e.g.- java.lang.String- getCNText(int flags)Gets the label text for the Common Navigator.- java.lang.String- getCNText(int columnIndex, int flags)Gets the text for columns.- protected java.lang.String- getCNText0(GProp<?> property, int flags)Gets the text for a sub-property for the Common Navigator.- protected java.lang.String- getCNText0(GProp<?> property, int columnIndex, int flags)Gets the text for a sub-property for the Common Navigator.- protected PropertyEditorSetup- getPropertyEditorSetup()Gets the Setup used for iiziGo, subclasses must override and provide their instance.- EditorVirtualSpace- getVirtualSpaceProp()For any designer, get the VirtualSpace property.- boolean- hasCNChildren(int flags)Checks if there are children in this container for Common Navigator.- boolean- hasCNToolTip(org.eclipse.jface.viewers.ViewerCell cell)Checks for Common Navigator tool-tip for this item.- boolean- isCNVisible(int flags)Visibility: hide participants container.- boolean- isCNVisible0(GProp<?> property, int flags)Checks if a property should be included in the view or if it's hidden or filtered out.- PasteFeedback- paste(boolean doPerformPaste, int position, GProp<?>[] props, int operation, java.lang.String description, IPropUndoRedo undoRedo)Validates or performs a paste operation.- Methods inherited from class com.iizigo.prop.DesignerProp- addCommandContributionItem, addContextMenuItems, addContextMenuItems, addContextMenuItems, addMarker, appendCNStyledTextAdditions, appendTooltipPropErrors, appendTooltipPropErrors, clearPropErrorMarkers, createCNToolTip, createCNToolTip0, createCNToolTipItemList, createFileErrorAtom, createImageDefinitions, dispose, doSortIndexOnCategories, firePropertyUpdateViewerEvent, getAdapter, getCNBackground, getCNBackground, getCNDescription, getCNDescription, getCNDescription0, getCNForeground, getCNForeground, getCNImage, getCNImage, getCNImage, getCNImage0, getCNImage0, getCNParent, getCNStyledText, getCNStyledText, getCNStyledText0, getCNText, getCNText, getCNToolTipDisplayDelayTime, getCNToolTipDisplayDelayTime, getCNToolTipDisplayDelayTime0, getCNToolTipShift, getCNToolTipShift, getCNToolTipShift0, getCNToolTipTimeDisplayed, getCNToolTipTimeDisplayed, getCNToolTipTimeDisplayed0, getContextMenuItems, getDataDesignerProp, getErrorSeverity, getException, getFolder, getFolderProp, getIEditorFileActions, getInstance, getInstance, getIResource, getJavaProject, getMarkers, getModel, getModificationStamp, getParent, getParentFolderProp, getProject, getPropCnr, getRoot, getSubPropertyName, getTransferDefaultPasteAllowed, getUndoContextFromTree, hasCNToolTip, hasCNToolTip0, hasMarkerID, hasNamingError, isBeforeAfterDropTarget, isDesignerLoaded, isDesignerMoved, onEvent, onPropErrorChanged, pasteProperties, processQuery, rebuildPropErrorMarkers, removeFileErrors, removeMarkers, setDesignerLoaded, setDesignerMoved, setException, setIEditorFileActions, setIResource, setIResource, setModificationStamp, setTransferDefaultPasteAllowed, toString, updateFolderResources, validateClasses, validateResouce
 
 
- Constructor Detail- VirtualSpaceDesignerProp- public VirtualSpaceDesignerProp(PropCnr propertyContainer) The constructor.- Parameters:
- propertyContainer-
 
 
 - Method Detail- getVirtualSpaceProp- public EditorVirtualSpace getVirtualSpaceProp() For any designer, get the VirtualSpace property.- Returns:
- The EditorVirtualSpace instance, never null.
 
 - getPropertyEditorSetup- protected PropertyEditorSetup getPropertyEditorSetup() Gets the Setup used for iiziGo, subclasses must override and provide their instance.- Overrides:
- getPropertyEditorSetupin class- DesignerProp
 
 - isCNVisible- public boolean isCNVisible(int flags) Visibility: hide participants container.- Overrides:
- isCNVisiblein class- DesignerProp
- Parameters:
- flags- The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
- Returns:
- true Default is always true.
 
 - getCNRealProp- public DesignerProp getCNRealProp() Gets the "real" property when the DesignerProp has been retrieved from e.g. the ContentProvider at add/remove events. The property parent might not be the same as the DesignerProp.- Overrides:
- getCNRealPropin class- DesignerProp
- Returns:
- By default, it is the "this" instance, but e.g. EditorVSRow for tables overrides it and returns the parent DesignerProp instead.
 
 - getCNParent- public java.lang.Object getCNParent(int flags) Gets the parent for Common Navigator.- Specified by:
- getCNParentin interface- INavigatorPresentation
- Overrides:
- getCNParentin class- DesignerProp
- Parameters:
- flags- The flag that apply is FLAG_PACKAGE_VIEW.
- Returns:
- The parent object: IProject or DesignerProp, or null if no parent exists (property is not added to a container).
 
 - hasCNChildren- public boolean hasCNChildren(int flags) Checks if there are children in this container for Common Navigator.- Specified by:
- hasCNChildrenin interface- INavigatorPresentation
- Overrides:
- hasCNChildrenin class- DesignerProp
- Parameters:
- flags- The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
- Returns:
- trueif the node has children, and- falseif it has no children.
 
 - getCNChildren- public java.lang.Object[] getCNChildren(int flags) Gets the children of this container for Common Navigator.- Specified by:
- getCNChildrenin interface- INavigatorPresentation
- Overrides:
- getCNChildrenin class- DesignerProp
- Parameters:
- flags- The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
- Returns:
- An array of children objects or EMPTY_ARRAY for none.
 
 - getCNImage- public org.eclipse.swt.graphics.Image getCNImage(int flags) Gets the image for the Common Navigator.- Specified by:
- getCNImagein interface- INavigatorPresentation
- Overrides:
- getCNImagein class- DesignerProp
- Parameters:
- flags- The flags for the image, see FLAG_IMAGE_*.
- Returns:
- Image or nullif there is no image.
 
 - getCNCategory- public int getCNCategory() Gets the category of this Common Navigator object, used for sorting.- Specified by:
- getCNCategoryin interface- INavigatorPresentation
- Overrides:
- getCNCategoryin class- DesignerProp
- Returns:
- Category for VirtualSpace, otherwise zero.
 
 - getCNText- public java.lang.String getCNText(int flags) Gets the label text for the Common Navigator.- Specified by:
- getCNTextin interface- INavigatorPresentation
- Overrides:
- getCNTextin class- DesignerProp
- Returns:
- String or or nullif there is no text.
 
 - getCNText- public java.lang.String getCNText(int columnIndex, int flags)Gets the text for columns.- Specified by:
- getCNTextin interface- INavigatorPresentation
- Overrides:
- getCNTextin class- DesignerProp
- Parameters:
- columnIndex- The zero-based index for the column (zero is never used, the method getCNText() is called instead.
- Returns:
- String or or nullif there is no text for the given object at columnIndex.
 
 - getCNDescriptionType- public java.lang.String getCNDescriptionType() Provide a type description for the status bar view, if available.- Overrides:
- getCNDescriptionTypein class- DesignerProp
- Returns:
- A type description for the status bar view, or null if not available.
 
 - getCNComparator- public IViewerComparator getCNComparator() Gets the comparator. For table, no sorting is done. This will keep Rows and Headers in correct ordering.- Specified by:
- getCNComparatorin interface- INavigatorPresentation
- Overrides:
- getCNComparatorin class- DesignerProp
- Returns:
- The default comparator. Subclasses can inhibit sorting by returning null.
 
 - hasCNToolTip- public boolean hasCNToolTip(org.eclipse.jface.viewers.ViewerCell cell) Checks for Common Navigator tool-tip for this item.- Overrides:
- hasCNToolTipin class- DesignerProp
- Parameters:
- cell- The cell (might be in a table), or null for none.
 
 - createCNToolTip- public org.eclipse.swt.widgets.Composite createCNToolTip(org.eclipse.swt.widgets.Event event, org.eclipse.jface.viewers.ViewerCell cell, org.eclipse.swt.widgets.Composite parent)Requests creates of the Composite used to show the tooltip.- Overrides:
- createCNToolTipin class- DesignerProp
- Parameters:
- event- Event triggering the tooltip (mouse hover).
- cell- The cell (might be in a table).
- parent- The parent composite.
- Returns:
- The created composite in the parent.
 
 - canPerform- public java.lang.String canPerform(int operation) Checks if an operation on this property is permitted. Subclasses can override this method and return an error message, the default is to return null.- Overridden for Web Service: delete/move not possible for Input/Output, link supported for Input/Output and Input Parameters. - Overrides:
- canPerformin class- DesignerProp
- Parameters:
- operation- The operation: OP_MOVE or OP_DELETE.
- Returns:
- null for OK, otherwise an error message.
 
 - isCNVisible0- public boolean isCNVisible0(GProp<?> property, int flags) Checks if a property should be included in the view or if it's hidden or filtered out.- Overrides:
- isCNVisible0in class- DesignerProp
- Parameters:
- property- The property in question.
- flags- The flags: FLAG_PACKAGE_VIEW, FLAG_SHOW_EMPTY_MAIN_FOLDER, FLAG_SHOW_EMPTY_PACKAGES, FLAG_SHOW_FILE_ITEMS, FLAG_SHOW_DESIGNER_PROPERTIES and FLAG_SHOW_SUBPROPERTIES are relevant.
- Returns:
- true Default is always true.
 
 - getCNText0- protected java.lang.String getCNText0(GProp<?> property, int flags) Gets the text for a sub-property for the Common Navigator.- Overrides:
- getCNText0in class- DesignerProp
 
 - getCNText0- protected java.lang.String getCNText0(GProp<?> property, int columnIndex, int flags) Gets the text for a sub-property for the Common Navigator.- Overrides:
- getCNText0in class- DesignerProp
 
 - getCNForeground0- protected org.eclipse.swt.graphics.Color getCNForeground0(GProp<?> property, int columnIndex, int flags) Provides a foreground color for the given element.- Overrides:
- getCNForeground0in class- DesignerProp
 
 - getCNBackground0- protected org.eclipse.swt.graphics.Color getCNBackground0(GProp<?> property, int columnIndex, int flags) Provides a background color for the given element at the specified index.- Overrides:
- getCNBackground0in class- DesignerProp
 
 - paste- public PasteFeedback paste(boolean doPerformPaste, int position, GProp<?>[] props, int operation, java.lang.String description, IPropUndoRedo undoRedo) Validates or performs a paste operation. The paste can be a move operation.- Overrides:
- pastein class- DesignerProp
- Parameters:
- doPerformPaste- Flag indication operation is to be performed (true) or just tested for validity (false).
- position- Position for paste: -1=before target, 0=in target, 1=after target.
- props- The properties.
- operation- The operation: OP_COPY or OP_MOVE.
- description- The description of the operation "source" for undo history.
- undoRedo- The undo/redo interface.
- Returns:
- The feed-back instance.