DefaultPaletteItem Class

com.bea.ide.jspdesigner
DefaultPaletteItem Class

public class DefaultPaletteItem

    extends PaletteItem

Default implementation for an insert palette item. Provides basic behavior to return the both the display string and the minimal insert document for the associated JSP tag.

Related Topics

PaletteItem


Hierarchy
Object
  PaletteItem
    DefaultPaletteItem

Constructor Summary

DefaultPaletteItem(IDOMDocument document, TagInfo tagInfo)

Class constructor specifying the document and the JSP tag info that the palette item is associated with.
 

Method Summary

public IDOMDocument
getDocument()
Returns the IDOMDocument object associated with the palette item.
public IDOMDocument
getInsertDocument()
Returns a document which contains the code to be inserted into the document.
public String
getLabel()
Returns the string that should be displayed in the palette to represent this item.
public TagInfo
getTagInfo()
Returns the TagInfo object associated with the palette item.
 
Methods from  com.bea.ide.jspdesigner.PaletteItem
canHaveParent, getIcon, getInsertWizard,
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Constructor Detail

DefaultPaletteItem

public DefaultPaletteItem(IDOMDocument document, 
                          TagInfo tagInfo)
Class constructor specifying the document and the JSP tag info that the palette item is associated with.
 

Method Detail

getDocument() Method

public IDOMDocument getDocument()
Returns the IDOMDocument object associated with the palette item.

Returns

Associated IDOMDocument object.

getInsertDocument() Method

public IDOMDocument getInsertDocument()
Returns a document which contains the code to be inserted into the document. If the PaletteItem has an InsertWizard then this return value is only used to provide the user with feedback as to where the element will be dropped. In this case, it is acceptable for this method to return null, in which case the user might not receive accurate feedback about where the drop will occur.

Overrides
PaletteItem.getInsertDocument()

Returns

A minimal JSP document containing the JSP action and taglib declaratoin for the associated TagInfo.

Related Topics

TagInfo


getLabel() Method

public String getLabel()
Returns the string that should be displayed in the palette to represent this item. Queries the associated TagInfo and returns the display name attribute from the TLD file.

Overrides
PaletteItem.getLabel()

Returns

Display name text for palette item.

getTagInfo() Method

public TagInfo getTagInfo()
Returns the TagInfo object associated with the palette item.

Returns

Associated TagInfo object.