Interface passed to custom tag renderers during HTML rendering process. Tags renderer themselves as HTML using this interface.
Related Topics
Method Summary |
public void |
|
public void |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public boolean |
|
public boolean |
|
public | |
public void |
|
public |
|
public |
|
public boolean |
|
public boolean |
|
public boolean | |
public void | |
public void |
|
public void |
Method Detail |
public void createDropPoint(IDOMNode
nodeParent)
Causes the current tag to become a drop point which inserts into the
specified node.
public void createVirtualDropPoint(Causes the current tag to become a drop point which inserts into nodeParentVirtual which in turn gets appended to nodeParent. nodeParentVirtual should be a node in the same document as nodeParent which has not yet been added to the tree.IDOMNode
nodeParent,IDOMNode
nodeParentVirtual)
publicEscapes a string for output in an HTML document. Reserved HTML characters such as <, >, &, " and ' are escaped so as to not cause invalid HTML to be produced.String
escapeHTML(String
str)
publicExtracts a file from the specified location to the temporary directory, and returns the URL to that file, or null.String
extractFile(URL
urlSrc)
public IDOMDocument
getActiveDocument()
Returns the document which is actually the one being currently designed.
Use this to decide whether or not to output placeholder images.
public String
getCurrentAttribute()
Returns the name of the current attribute that the HTML is inside,
or null if not currently inside of an attribute.
publicRetrieves the value of a property.Object
getProperty(Object
key)
Related Topics
IHTMLWriter.setProperty(Object, Object)
public boolean includeFile(URI
uri)
Includes the contents of another file in the output. Clicking on that
portion of the output will result in the specified file being selected
as a whole. Individual elements will not be selectable.
public boolean isSafeForTag(String
strTagName)
Returns true if the specified tag can be output at this point. False
if not, (e.g. because we're inside of an attribute, or not in the
<body>, or inside of a <tr>, etc.
publicTakes an URL which is relative to the document, and maps it to a local file system URL. The file referred to by strSrc is not moved.String
mapURL(String
strSrc)
public void onExpression()Notifies the IHTMLWriter that an expression appears at this point in the document. If appropriate, the IHTMLWriter will fix up the value of the current attribute (such as, for <img src="{expression}">, it will change the 'src' attribute to point to valid placeholder image.
publicMaps a page-relative URI to an absolute URI.URI
pageRelativeURI(String
str)
publicAllows setting of properties for cross-renderer communication The key can be anything, but typically is equal to value.getClass(). Returns the previous value of the property, or null if the property was not set before. Renderers should use this to store rendering state information, using this.getClass() as the property key.Object
setProperty(Object
key,Object
value)
Related Topics
IHTMLWriter.getProperty(Object)
public boolean showScripts(IDOMNode
node)
Determines if scripting/design information should be shown for a
particular node. Explicitly returns false for nodes that aren't from
the active document, e.g. nodes from includes.
Related Topics
IHTMLWriter.showTableBorders(IDOMNode)
IHTMLWriter.showTags(IDOMNode)
public boolean showTableBorders(IDOMNode
node)
Determines if renderers should display table borders for a particular
node. Explicitly returns false for nodes that aren't from the active
document, e.g. nodes from includes.
Related Topics
IHTMLWriter.showScripts(IDOMNode)
IHTMLWriter.showTags(IDOMNode)
public boolean showTags(IDOMNode
node)
Determines if renderers should show tags names when rendering design
elements.
node
. Related Topics
IHTMLWriter.showScripts(IDOMNode)
IHTMLWriter.showTableBorders(IDOMNode)
public void write(String
str)
Outputs a string to the HTML stream. String contents are not
escaped when written to the HTML stream.
public void writeChildren(IDOMNode
node)
Writes out an HTML representation of all the children of the
specified node.
public void writeNode(IDOMNode
node)
Writes out an HTML representation of the specified node. If the user
clicks on the HTML in the designer, then the node which generated
that HTML will be selected.