org.mozilla.pluglet.mozilla
Interface PlugletTagInfo2


public interface PlugletTagInfo2
extends PlugletTagInfo

This interface extends PlugletTagInfo, providing additional information about Pluglet tags (elements).


Method Summary
 java.lang.String getAlignment()
          Returns the alignment attribute in the tag.
 java.lang.String getAttribute(java.lang.String name)
          Returns a value for a particular attribute.
 java.util.Properties getAttributes()
          Returns all the name-value pairs found in the tag attributes.
 int getBorderHorizSpace()
          Returns an int for the border horizontal space attribute of the tag (e.g., hspace with IMG tag).
 int getBorderVertSpace()
          Returns an int for the border vertical space attribute of the tag (e.g., vspace with IMG tag).
 java.lang.String getDocumentBase()
          Gets the base for the document.
 java.lang.String getDocumentEncoding()
          Returns the character encoding used in the document (e.g., ASCSII, Big5 (Traditional Chinese), Cp1122 (IBM Estonia).
 int getHeight()
          Returns an int for the height attribute of the tag.
 java.lang.String getTagText()
          Gets the complete text of the HTML tag that was used to instantiate this Pluglet instance.
 java.lang.String getTagType()
          Gets the HTML tag type associated with creation of the Pluglet instance.
 int getUniqueID()
          Returns a unique ID for the current document in which the Pluglet is displayed.
 int getWidth()
          Returns an int value for the width attribute of the tag.
 

Method Detail

getAttributes

public java.util.Properties getAttributes()
Description copied from interface: PlugletTagInfo
Returns all the name-value pairs found in the tag attributes.

Specified by:
getAttributes in interface PlugletTagInfo
Tags copied from interface: PlugletTagInfo
Returns:
Returns the attributes of an HTML tag as type java.util.Properties.

getAttribute

public java.lang.String getAttribute(java.lang.String name)
Description copied from interface: PlugletTagInfo
Returns a value for a particular attribute. Returns NULL if the attribute does not exist.

Specified by:
getAttribute in interface PlugletTagInfo
Tags copied from interface: PlugletTagInfo
Parameters:
name - This is the name of the attribute.

Returns:
Returns the value of the named attribute as a String.

getTagType

public java.lang.String getTagType()
Gets the HTML tag type associated with creation of the Pluglet instance. Possible types are EMBED, APPLET, and OBJECT.

Returns:
Returns a String for the tag type as described above.

getTagText

public java.lang.String getTagText()
Gets the complete text of the HTML tag that was used to instantiate this Pluglet instance.

Returns:
Returns a String for the tag text as described above.

getDocumentBase

public java.lang.String getDocumentBase()
Gets the base for the document. The base, in conjunction with a relative URL, specifies the absolute path to the document.

Returns:
Returns a String representing the document base as described above.

getDocumentEncoding

public java.lang.String getDocumentEncoding()
Returns the character encoding used in the document (e.g., ASCSII, Big5 (Traditional Chinese), Cp1122 (IBM Estonia). For a list of possible character encodings, see:

http://java.sun.com/products/jdk/1.1/docs/guide/
intl/intl.doc.html#25303

Returns:
Returns a String for the document encoding as described above.

getAlignment

public java.lang.String getAlignment()
Returns the alignment attribute in the tag.

Returns:
Returns the alignment attribute as described above.

getWidth

public int getWidth()
Returns an int value for the width attribute of the tag.

Returns:
Returns an integer value for the width as described above.

getHeight

public int getHeight()
Returns an int for the height attribute of the tag.

Returns:
Returns an integer value for the height as described above.

getBorderVertSpace

public int getBorderVertSpace()
Returns an int for the border vertical space attribute of the tag (e.g., vspace with IMG tag).

Returns:
Returns an integer value for the border vertical space attribute.

getBorderHorizSpace

public int getBorderHorizSpace()
Returns an int for the border horizontal space attribute of the tag (e.g., hspace with IMG tag).

Returns:
Returns an integer value for the border horizontal space attribute.

getUniqueID

public int getUniqueID()
Returns a unique ID for the current document in which the Pluglet is displayed.

Returns:
Returns an ID for the current document as described above.