Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


org.eclipse.jet.taglib
Interface CustomTag

All Known Subinterfaces:
ConditionalTag, ContainerTag, EmptyTag, FunctionTag, IteratingTag, OtherTag
All Known Implementing Classes:
AbstractConditionalTag, AbstractContainerTag, AbstractCustomTag, AbstractEmptyTag, AbstractFunctionTag, AbstractIteratingTag, AbstractOtherTag

public interface CustomTag

Interface representing common characteristics of JET2 custom tags.

All custom tags have the same setup sequence. The following methods are always called to initialize a tag:

  • setParent(CustomTag) specifying the containing tag, if any.
  • setTagInfo(TagInfo) specifying the tag attribute values.
  • setContext(JET2Context) specifying the JET execution context.
  • setOut(JET2Writer) specifying the writer to which the tag should write.
  • This interface is not intended to be directly implemented by clients


    Method Summary
     java.lang.String getAttribute (java.lang.String name)
              Return the processed value of the tag attribute (with dynamic XPath expressions already resolved.
      CustomTagKind getKind ()
              Return the kind of the custom tag
      JET2Writer getOut ()
              Return the writer to which the tag will write.
      CustomTag getParent ()
              Return the parent tag.
     java.lang.String getRawAttribute (java.lang.String name)
              Return the 'raw' value of the named tag attribute.
     void setContext ( JET2Context context)
              Set the context of the tag.
     void setOut ( JET2Writer out)
              Set the writer to which the tag will write.
     void setParent ( CustomTag parent)
              Set the custom tag representing the parent of this tag.
     void setTagInfo ( TagInfo td)
              Set the tag info for the tag.
     

    Method Detail

    setParent

    void setParent(
    CustomTag parent)
    Set the custom tag representing the parent of this tag.

    Parameters:
    parent - the parent tag, or null if the tag has none.

    getParent

    CustomTag getParent()
    Return the parent tag.

    Returns:
    the parent tag, or null if the tag has none.

    getKind

    CustomTagKind getKind()
    Return the kind of the custom tag

    Returns:
    the tag kind
    See Also:
    CustomTagKind

    setTagInfo

    void setTagInfo(
    TagInfo td)
    Set the tag info for the tag. This is done by the compiler, and is not intended to be called by clients.

    Parameters:
    td - the tag info.

    setContext

    void setContext(
    JET2Context context)
    Set the context of the tag. This is done by the compiler, and is not intended to be called by clients.

    Parameters:
    context - the context.

    getRawAttribute

    java.lang.String getRawAttribute(java.lang.String name)
    Return the 'raw' value of the named tag attribute.

    Parameters:
    name - the tag attribute name.
    Returns:
    the raw value or null if the attribute is not defined.

    getAttribute

    java.lang.String getAttribute(java.lang.String name)
                                  throws 
    JET2TagException
    
    Return the processed value of the tag attribute (with dynamic XPath expressions already resolved.

    Parameters:
    name - the tag attribute name.
    Returns:
    the processed value of null if the attribute is not defined.
    Throws:
    JET2TagException - if an error occurs while processing a dynmaic XPath expression.

    setOut

    void setOut(
    JET2Writer out)
    Set the writer to which the tag will write.

    Parameters:
    out - a non-null instance of JET2Writer.

    getOut

    JET2Writer getOut()
    Return the writer to which the tag will write.

    Returns:
    the tag's writer.

    Copyright 2006 IBM Corporation and others.
    All Rights Reserved.


     
     
      Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire