[jbosstools-commits] JBoss Tools SVN: r2605 - trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template.

Author: ayukhovich Date: 2007-07-23 10:04:30 -0400 (Mon, 23 Jul 2007) New Revision: 2605 Modified: trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeTemplate.java Log: http://jira.jboss.com/jira/browse/JBIDE-531 add external java-doc for function isHaveVisualPreview() Modified: trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeTemplate.java =================================================================== --- trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeTemplate.java 2007-07-23 13:39:44 UTC (rev 2604) +++ trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeTemplate.java 2007-07-23 14:04:30 UTC (rev 2605) @@ -7,7 +7,7 @@ * * Contributors: * Exadel, Inc. and Red Hat, Inc. - initial API and implementation - ******************************************************************************/ + ******************************************************************************/ package org.jboss.tools.vpe.editor.template; import org.jboss.tools.jst.jsp.editor.ITextFormatter; @@ -25,247 +25,395 @@ /** * Initiates template after its creating - * @param templateElement <code>Element</code> with a name "vpe:template" from the template file - * @param caseSensitive The case sensitive of an element of a source file + * + * @param templateElement + * <code>Element</code> with a name "vpe:template" from the + * template file + * @param caseSensitive + * The case sensitive of an element of a source file */ void init(Element templateElement, boolean caseSensitive); /** - * Creates a node of the visual tree on the node of the source tree. - * This visual node should not have the parent node - * This visual node can have child nodes. - * @param pageContext Contains the information on edited page. - * @param sourceNode The current node of the source tree. - * @param visualDocument The document of the visual tree. - * @return The information on the created node of the visual tree. + * Creates a node of the visual tree on the node of the source tree. This + * visual node should not have the parent node This visual node can have + * child nodes. + * + * @param pageContext + * Contains the information on edited page. + * @param sourceNode + * The current node of the source tree. + * @param visualDocument + * The document of the visual tree. + * @return The information on the created node of the visual tree. */ - VpeCreationData create(VpePageContext pageContext, Node sourceNode, Document visualDocument); - + VpeCreationData create(VpePageContext pageContext, Node sourceNode, + Document visualDocument); + /** - * Is invoked after construction of all child nodes of the current visual node. - * @param pageContext Contains the information on edited page. - * @param sourceNode The current node of the source tree. - * @param visualDocument The document of the visual tree. - * @param data Object <code>VpeCreationData</code>, built by a method <code>create</code> + * Is invoked after construction of all child nodes of the current visual + * node. + * + * @param pageContext + * Contains the information on edited page. + * @param sourceNode + * The current node of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param data + * Object <code>VpeCreationData</code>, built by a method + * <code>create</code> */ - void validate(VpePageContext pageContext, Node sourceNode, Document visualDocument, VpeCreationData data); - + void validate(VpePageContext pageContext, Node sourceNode, + Document visualDocument, VpeCreationData data); + /** * Processes keyboard input (without the pressed key Ctrl) - * @param pageContext Contains the information on edited page. - * @param sourceDocument The document of the source tree. - * @param sourceNode The current node of the source tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @param charCode Code of the pressed key - * @param selection The current selection - * @param formatter Interface for formatting the source text + * + * @param pageContext + * Contains the information on edited page. + * @param sourceDocument + * The document of the source tree. + * @param sourceNode + * The current node of the source tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @param charCode + * Code of the pressed key + * @param selection + * The current selection + * @param formatter + * Interface for formatting the source text * @return <code>true</code> if the key is processed */ - boolean nonctrlKeyPressHandler(VpePageContext pageContext, Document sourceDocument, Node sourceNode, Node visualNode, Object data, int charCode, VpeSourceSelection selection, ITextFormatter formatter); - + boolean nonctrlKeyPressHandler(VpePageContext pageContext, + Document sourceDocument, Node sourceNode, Node visualNode, + Object data, int charCode, VpeSourceSelection selection, + ITextFormatter formatter); + /** - * Sets value of attribute of the current visual element. - * Is invoked at change of attribute of an source element. - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @param name Attribute name. - * @param value Attribute value. + * Sets value of attribute of the current visual element. Is invoked at + * change of attribute of an source element. + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @param name + * Attribute name. + * @param value + * Attribute value. */ - void setAttribute(VpePageContext pageContext, Element sourceElement, Document visualDocument, Node visualNode, Object data, String name, String value); - + void setAttribute(VpePageContext pageContext, Element sourceElement, + Document visualDocument, Node visualNode, Object data, String name, + String value); + /** * Informs on remove of attribute of the current source element. - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @param name Attribute name. + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @param name + * Attribute name. */ - void removeAttribute(VpePageContext pageContext, Element sourceElement, Document visualDocument, Node visualNode, Object data, String name); - + void removeAttribute(VpePageContext pageContext, Element sourceElement, + Document visualDocument, Node visualNode, Object data, String name); + /** * Is invoked before removal of the visiblis node from the tree - * @param pageContext Contains the information on edited page. - * @param sourceNode The current node of the source tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> + * + * @param pageContext + * Contains the information on edited page. + * @param sourceNode + * The current node of the source tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> */ - void beforeRemove(VpePageContext pageContext, Node sourceNode, Node visualNode, Object data); - + void beforeRemove(VpePageContext pageContext, Node sourceNode, + Node visualNode, Object data); + /** - * At a modification of the node of an source tree, the method update - * for this node is invoked. Template can indicate other node for update - * @param pageContext Contains the information on edited page. - * @param sourceNode The current node of the source tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @return For this node of an source tree the method update is invoked. - * If null, that is invoked update for current source node + * At a modification of the node of an source tree, the method update for + * this node is invoked. Template can indicate other node for update + * + * @param pageContext + * Contains the information on edited page. + * @param sourceNode + * The current node of the source tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @return For this node of an source tree the method update is invoked. If + * null, that is invoked update for current source node */ - Node getNodeForUptate(VpePageContext pageContext, Node sourceNode, Node visualNode, Object data); - + Node getNodeForUptate(VpePageContext pageContext, Node sourceNode, + Node visualNode, Object data); + /** * Is invoked at resize of an element visual tree - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualElement The current element of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @param resizerConstrains Code of resizer:<br> - * top-left: 1<br> - * top: 2<br> - * top-right: 4<br> - * left: 8<br> - * right: 16<br> - * bottomleft: 32<br> - * bottom: 64<br> - * bottom-right: 128<br> - * @param top Element top - * @param left Element left - * @param width Element width - * @param height Element height + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualElement + * The current element of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @param resizerConstrains + * Code of resizer:<br> + * top-left: 1<br> + * top: 2<br> + * top-right: 4<br> + * left: 8<br> + * right: 16<br> + * bottomleft: 32<br> + * bottom: 64<br> + * bottom-right: 128<br> + * @param top + * Element top + * @param left + * Element left + * @param width + * Element width + * @param height + * Element height */ - void resize(VpePageContext pageContext, Element sourceElement, Document visualDocument, Element visualElement, Object data, int resizerConstrains, int top, int left, int width, int height); - + void resize(VpePageContext pageContext, Element sourceElement, + Document visualDocument, Element visualElement, Object data, + int resizerConstrains, int top, int left, int width, int height); + /** - * Checks a capability of drag of visual element - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualElement The current element of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> + * Checks a capability of drag of visual element + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualElement + * The current element of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> * @return <code>true</code> The element can be dragged */ - boolean canInnerDrag(VpePageContext pageContext, Element sourceElement, Document visualDocument, Element visualElement, Object data); - + boolean canInnerDrag(VpePageContext pageContext, Element sourceElement, + Document visualDocument, Element visualElement, Object data); + /** * Checks a capability to drop an element in the container - * @param pageContext Contains the information on edited page. - * @param container Element-Container - * @param sourceDragNode Node for drop + * + * @param pageContext + * Contains the information on edited page. + * @param container + * Element-Container + * @param sourceDragNode + * Node for drop * @return <code>true</code> The node can be dropped */ - boolean canInnerDrop(VpePageContext pageContext, Node container, Node sourceDragNode); - + boolean canInnerDrop(VpePageContext pageContext, Node container, + Node sourceDragNode); + /** * Is invoked at drop of an element visual tree - * @param pageContext Contains the information on edited page. - * @param dragInfo The information on the dragged element - * @param dropInfo The information on the drop container + * + * @param pageContext + * Contains the information on edited page. + * @param dragInfo + * The information on the dragged element + * @param dropInfo + * The information on the drop container */ - void innerDrop(VpePageContext pageContext, VpeSourceInnerDragInfo dragInfo, VpeSourceInnerDropInfo dropInfo); - + void innerDrop(VpePageContext pageContext, VpeSourceInnerDragInfo dragInfo, + VpeSourceInnerDropInfo dropInfo); + /** * Returns <code>VpeTagDescription</code> - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualElement The current element of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualElement + * The current element of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> * @return <code>VpeTagDescription</code> */ - VpeTagDescription getTagDescription(VpePageContext pageContext, Element sourceElement, Document visualDocument, Element visualElement, Object data); - + VpeTagDescription getTagDescription(VpePageContext pageContext, + Element sourceElement, Document visualDocument, + Element visualElement, Object data); + /** - * Checks, whether it is necessary to re-create an element at change of attribute - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param visualDocument The document of the visual tree. - * @param visualNode The current node of the visual tree. - * @param data The arbitrary data, built by a method <code>create</code> - * @param name Atrribute name - * @param value Attribute value - * @return <code>true</code> if it is required to re-create an element at a modification of attribute, <code>false</code> otherwise. + * Checks, whether it is necessary to re-create an element at change of + * attribute + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param visualDocument + * The document of the visual tree. + * @param visualNode + * The current node of the visual tree. + * @param data + * The arbitrary data, built by a method <code>create</code> + * @param name + * Atrribute name + * @param value + * Attribute value + * @return <code>true</code> if it is required to re-create an element at + * a modification of attribute, <code>false</code> otherwise. */ - boolean isRecreateAtAttrChange(VpePageContext pageContext, Element sourceElement, Document visualDocument, Node visualNde, Object data, String name, String value); - + boolean isRecreateAtAttrChange(VpePageContext pageContext, + Element sourceElement, Document visualDocument, Node visualNde, + Object data, String name, String value); + /** * @return <code>true</code> if the element can have children */ boolean isChildren(); - + /** * @return <code>true</code> if the element is case sensitive */ boolean isCaseSensitive(); - - + /** + * Return <code>true</code> if the element has visual preview on tab 'Preview', otherwise <code>false</code>. + * This value initialized in attribute <b>haveVisualPreview</b> for tag <b>&lt;vpe:template&gt</b>. + * Default value <code>true</code> if this attribute not present. <br/>For example tag <code>&lt;h:form&gt;</code>:<br/> + * In visual editor (see tab 'Visual') have a red border, but it not visible on tab 'Preview'. See part code for this template:<br> + * <code>&lt;vpe:template children="yes" modify="yes" haveVisualPreview="no"&gt;</code><br><br> + *This element have visible on tab 'Preview:'<br/> + *<code>&lt;vpe:template children="yes" modify="yes" haveVisualPreview="yes"&gt;</code> <br/> + *or<br/> + *<code>&lt;vpe:template children="yes" modify="yes" &gt;</code><br/> + * <br/><br/>This element have not visible on tab 'Preview':<br/> + * <code>&lt;vpe:template children="yes" modify="yes" haveVisualPreview="no"&gt;</code> * @return <code>true</code> if the element is have visual preview */ - boolean isHaveVisualPreview(); - + boolean isHaveVisualPreview(); + /** * Returns the data for formatting an element of source tree + * * @return <code>TextFormatingData</code> */ TextFormatingData getTextFormatingData(); - + /** - * Returns a list of attributes of an element of the source tree, - * the values which one are mapped in the visiblis editor + * Returns a list of attributes of an element of the source tree, the values + * which one are mapped in the visiblis editor + * * @return attrubute name array */ - String [] getOutputAtributeNames(); + String[] getOutputAtributeNames(); /** * Is invoked at a change of bundle values - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param data The arbitrary data, built by a method <code>create</code> + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param data + * The arbitrary data, built by a method <code>create</code> */ - void refreshBundleValues(VpePageContext pageContext, Element sourceElement, Object data); + void refreshBundleValues(VpePageContext pageContext, Element sourceElement, + Object data); /** - * Opens proprties editor for bundle value - * Is invoked at double mouse click on visual element - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param data The arbitrary data, built by a method <code>create</code> + * Opens proprties editor for bundle value Is invoked at double mouse click + * on visual element + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param data + * The arbitrary data, built by a method <code>create</code> */ - void openBundleEditors(VpePageContext pageContext, Element sourceElement, Object data); + void openBundleEditors(VpePageContext pageContext, Element sourceElement, + Object data); /** * Opens editor of source file for include-element - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param data The arbitrary data, built by a method <code>create</code> + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param data + * The arbitrary data, built by a method <code>create</code> */ - void openIncludeEditor(VpePageContext pageContext, Element sourceElement, Object data); + void openIncludeEditor(VpePageContext pageContext, Element sourceElement, + Object data); /** * @deprecated - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param data The arbitrary data, built by a method <code>create</code> + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param data + * The arbitrary data, built by a method <code>create</code> */ - void setSourceAttributeValue(VpePageContext pageContext, Element sourceElement, Object data); - + void setSourceAttributeValue(VpePageContext pageContext, + Element sourceElement, Object data); + /** - * If the value of attribute of an element of an source tree - * is mapped by the way of text node of a visual treer, - * this method returns the text node, otherwise - null - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. - * @param data The arbitrary data, built by a method <code>create</code> + * If the value of attribute of an element of an source tree is mapped by + * the way of text node of a visual treer, this method returns the text + * node, otherwise - null + * + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. + * @param data + * The arbitrary data, built by a method <code>create</code> * @return Text node or null */ - Node getOutputTextNode(VpePageContext pageContext, Element sourceElement, Object data); + Node getOutputTextNode(VpePageContext pageContext, Element sourceElement, + Object data); /** * @deprecated - * @param pageContext Contains the information on edited page. - * @param sourceElement The current element of the source tree. + * @param pageContext + * Contains the information on edited page. + * @param sourceElement + * The current element of the source tree. * @param offset * @param length * @param data */ - void setSourceAttributeSelection(VpePageContext pageContext, Element sourceElement, int offset, int length, Object data); + void setSourceAttributeSelection(VpePageContext pageContext, + Element sourceElement, int offset, int length, Object data); /** * @deprecated @@ -285,15 +433,20 @@ VpeAnyData getAnyData(); /** - * The unfilled element of an source tree can be mapped - * in the visiblis editor with the default contents - * This method fills default contents - * @param pageContext Contains the information on edited page. - * @param sourceContainer The current element of the source tree. - * @param visualContainer The current element of the visual tree. - * @param visualDocument The document of the visual tree. + * The unfilled element of an source tree can be mapped in the visiblis + * editor with the default contents This method fills default contents + * + * @param pageContext + * Contains the information on edited page. + * @param sourceContainer + * The current element of the source tree. + * @param visualContainer + * The current element of the visual tree. + * @param visualDocument + * The document of the visual tree. */ - void setPseudoContent(VpePageContext pageContext, Node sourceContainer, Node visualContainer, Document visualDocument); - + void setPseudoContent(VpePageContext pageContext, Node sourceContainer, + Node visualContainer, Document visualDocument); + boolean containsText(); } \ No newline at end of file