TreePropertyOverride (Apache Beehive NetUI API Documentation (Version 1.0.2))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.beehive.netui.tags.tree
Class TreePropertyOverride

Object
  SimpleTagSupport
      AbstractSimpleTag
          TreePropertyOverride

All Implemented Interfaces:: JspTag, SimpleTag, INetuiTag

public class TreePropertyOverride
extends AbstractSimpleTag
extends AbstractSimpleTag

Constructor Summary
`TreePropertyOverride()`

Method Summary
`void`	`doTag()` Render this Tree control.
`String`	`getTagName()` Return the name of the Tag.
`void`	`setExpansionAction(String action)` Sets the action used for expanding and contracting tree nodes.
`void`	`setIconRoot(String iconRoot)` This will set the location of the icon images.
`void`	`setImageRoot(String imageRoot)` Sets the name of the directory containing the images for our icons, relative to the page including this tag.
`void`	`setItemIcon(String itemIcon)` Sets the default icon for TreeElements for a blank area of the tree.
`void`	`setLastLineJoinImage(String lastLineJoinImage)` Sets the image name for a blank area of the tree.
`void`	`setLastNodeCollapsedImage(String lastNodeCollapsedImage)` Sets the image name for a closed non-leaf node with no line below it.
`void`	`setLastNodeExpandedImage(String lastNodeExpandedImage)` Sets the image name for an open non-leaf node with no line below it.
`void`	`setLineJoinImage(String lineJoinImage)` Sets the image name for an area with a line through it.
`void`	`setNodeCollapsedImage(String nodeCollapsedImage)` Sets the image name for a closed non-leaf node with a line below it.
`void`	`setNodeExpandedImage(String nodeExpandedImage)` Sets the image name for an open non-leaf node with a line below it.
`void`	`setSelectionAction(String action)` Sets the action used for expanding and contracting tree nodes.
`void`	`setSpacerImage(String spacerImage)` Sets the image name for an image used to align the other images inside of a tree.
`void`	`setVerticalLineImage(String verticalLineImage)` Sets the image name for an area with a line through it.

Methods inherited from class AbstractSimpleTag
`getBufferBody, getHtmlTag, getIdForTagId, getInlineError, getPageContext, getScriptReporter, getUserLocale, hasErrors, registerTagError, registerTagError, reportErrors, rewriteName, setNonEmptyValueAttribute, setRequiredValueAttribute, write`

Methods inherited from class SimpleTagSupport
`findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext, setParent`

Methods inherited from class Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

TreePropertyOverride

public TreePropertyOverride()

Method Detail

getTagName

public String getTagName()

Return the name of the Tag.

Specified by:: getTagName in interface INetuiTag
Specified by:: getTagName in class AbstractSimpleTag

Returns:: the name of the tag.

setSelectionAction

public void setSelectionAction(String action)

Sets the action used for expanding and contracting tree nodes.

Parameters:: action - the action

setExpansionAction

public void setExpansionAction(String action)

Sets the action used for expanding and contracting tree nodes.

Parameters:: action - the action

setLastNodeExpandedImage

public void setLastNodeExpandedImage(String lastNodeExpandedImage)

Sets the image name for an open non-leaf node with no line below it. (Defaults to "lastNodeExpanded.gif").

Parameters:: lastNodeExpandedImage - the image name (including extension)

setNodeExpandedImage

public void setNodeExpandedImage(String nodeExpandedImage)

Sets the image name for an open non-leaf node with a line below it. (Defaults to "nodeExpanded.gif").

Parameters:: nodeExpandedImage - the image name (including extension)

setLastNodeCollapsedImage

public void setLastNodeCollapsedImage(String lastNodeCollapsedImage)

Sets the image name for a closed non-leaf node with no line below it. (Defaults to "lastNodeCollapsed.gif").

Parameters:: lastNodeCollapsedImage - the image name (including extension)

setNodeCollapsedImage

public void setNodeCollapsedImage(String nodeCollapsedImage)

Sets the image name for a closed non-leaf node with a line below it. (Defaults to "nodeCollapsed.gif").

Parameters:: nodeCollapsedImage - the image name (including extension)

setLastLineJoinImage

public void setLastLineJoinImage(String lastLineJoinImage)

Sets the image name for a blank area of the tree. (Defaults to "lastLineJoin.gif").

Parameters:: lastLineJoinImage - the image name (including extension)

setSpacerImage

public void setSpacerImage(String spacerImage)

Sets the image name for an image used to align the other images inside of a tree. (Defaults to "spacer.gif").

Parameters:: spacerImage - the image name (including extension)

setItemIcon

public void setItemIcon(String itemIcon)

Sets the default icon for TreeElements for a blank area of the tree. (Defaults to "folder.gif").

Parameters:: itemIcon - the image name of the itemIcon

setLineJoinImage

public void setLineJoinImage(String lineJoinImage)

Sets the image name for an area with a line through it. (Defaults to "lineJoin.gif").

Parameters:: lineJoinImage - the image name (including extension)

setVerticalLineImage

public void setVerticalLineImage(String verticalLineImage)

Sets the image name for an area with a line through it. (Defaults to "verticalLine.gif").

Parameters:: verticalLineImage - the image name (including extension)

setImageRoot

public void setImageRoot(String imageRoot)

Sets the name of the directory containing the images for our icons, relative to the page including this tag.

Parameters:: imageRoot - the directory name

setIconRoot

public void setIconRoot(String iconRoot)

This will set the location of the icon images. When the location is explicitly set, this works exactly the same as all other inheritable properties. When this is not set, it will return the getImageRoot location.

Parameters:: iconRoot - the directory name for the icons

doTag

public void doTag()
           throws JspException

Render this Tree control.

Specified by:: doTag in interface SimpleTag
Overrides:: doTag in class SimpleTagSupport

Throws:: JspException - if a processing error occurs