org.jasig.portal.channels.jsp.tree
Class Images

java.lang.Object
  org.jasig.portal.channels.jsp.tree.Images

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class Images
extends Object

Represents a set of well known keys and the default URL paths for images used in rendering the tree. These are loaded from configuration using the values of the constants defined in this class having names of XXX_IMG. The matching constants having just the XXX names hold the values of the keys into the table. These keys are used in the tree control's renderer.jsp to embed the URL from the map for that key into the rendered html tree. Applications that use the tree control can provide their own maps of image names to image URLs using the XXX constant names for the keys and providing their own URL values in their map objects. These customized maps can then be passed to the Config object for use by the renderer. If only a portion of the images are to be overridden they can obtain the default URLs from the configuration system for the unchanged images using the XXX_IMG constants.

    FOLDER_OPEN             = "folderOpen"
    FOLDER_CLOSED           = "folderClosed"
    START_OF_CONTAINER      = "startOfContainer"
    END_OF_CONTAINER        = "endOfContainer"
    MIDDLE_BRANCH_COLLAPSED = "middleBranchCollapsed"
    MIDDLE_BRANCH_EXPANDED  = "middleBranchExpanded"
    LAST_BRANCH_COLLAPSED   = "lastBranchCollapsed"
    LAST_BRANCH_EXPANDED    = "lastBranchExpanded"
    NO_BRANCH               = "noBranch"
    TRANSPARENT_POINT       = "transparentPoint"
    MIDDLE_CHILD            = "middleChild"
    SKIPPED_CHILD_RPT       = "skippedChildRpt"
    SKIPPED_CHILD           = "skippedChild"
    LAST_CHILD              = "lastChild"
    SHOW_ASPECTS            = "showAspects"
    HIDE_ASPECTS            = "hideAspects"
 

Author:

Mark Boyd

Field Summary

static String	END_OF_CONTAINER Deprecated. Represents the key used by the renderer to obtain the URL for the containment end image in the tree when containment is being used.
static String	END_OF_CONTAINER_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default END_OF_CONTAINER image.
static String	FOLDER_CLOSED Deprecated. Represents the key used by the renderer to obtain the URL for the closed container node in the tree.
static String	FOLDER_CLOSED_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default FOLDER_CLOSED image.
static String	FOLDER_OPEN Deprecated. Represents the key used by the renderer to obtain the URL for the open container node in the tree.
static String	FOLDER_OPEN_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default FOLDER_OPEN image.
static String	HIDE_ASPECTS Deprecated. Represents the key used by the renderer to obtain the URL for an image used to hide aspects of a node in the tree.
static String	HIDE_ASPECTS_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default HIDE_ASPECTS image.
static String	LAST_BRANCH_COLLAPSED Deprecated. Represents the key used by the renderer to obtain the URL for the image depicting a collapsed branch point in the tree where there are no additional following sibling nodes.
static String	LAST_BRANCH_COLLAPSED_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_BRANCH_COLLAPSED image.
static String	LAST_BRANCH_EXPANDED Deprecated. Represents the key used by the renderer to obtain the URL for the image depicting an expanded branch point in the tree where there are no additional following sibling nodes.
static String	LAST_BRANCH_EXPANDED_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_BRANCH_EXPANDED image.
static String	LAST_CHILD Deprecated. Represents the key used by the renderer to obtain the URL for the branch of a non-expandable child node with no additional following sibling nodes.
static String	LAST_CHILD_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_CHILD image.
static String	MIDDLE_BRANCH_COLLAPSED Deprecated. Represents the key used by the renderer to obtain the URL for the image depicting a collapsed branch point in the tree where there are additional following sibling nodes.
static String	MIDDLE_BRANCH_COLLAPSED_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_BRANCH_COLLAPSED image.
static String	MIDDLE_BRANCH_EXPANDED Deprecated. Represents the key used by the renderer to obtain the URL for the image depicting an expanded branch point in the tree where there are additional following sibling nodes.
static String	MIDDLE_BRANCH_EXPANDED_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_BRANCH_EXPANDED image.
static String	MIDDLE_CHILD Deprecated. Represents the key used by the renderer to obtain the URL for the image representing the non expandable branch of a child node with additional following sibling nodes.
static String	MIDDLE_CHILD_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_CHILD image.
static String	NO_BRANCH Deprecated. Represents the key used by the renderer to obtain the URL for the image depicting an area of the tree not containing a branch.
static String	NO_BRANCH_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default NO_BRANCH image.
static String	SHOW_ASPECTS Deprecated. Represents the key used by the renderer to obtain the URL for an image used to show aspects of a node in the tree.
static String	SHOW_ASPECTS_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default SHOW_ASPECTS image.
static String	SKIPPED_CHILD Deprecated. Represents the key used by the renderer to obtain the URL for an image representing the branch leading from the parent of an exposed child to the parent's following sibling.
static String	SKIPPED_CHILD_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default SKIPPED_CHILD image.
static String	SKIPPED_CHILD_RPT Deprecated. Represents the key used by the renderer to obtain the URL for a vertically repeatable version of an image representing the branch leading from the parent of an exposed child to the parent's following sibling.
static String	SKIPPED_CHILD_RPT_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default SKIPPED_CHILD_RPT image.
static String	START_OF_CONTAINER Deprecated. Represents the key used by the renderer to obtain the URL for the containment start image in the tree when containment is being used.
static String	START_OF_CONTAINER_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default START_OF_CONTAINER image.
static String	TRANSPARENT_POINT Deprecated. Represents the key used by the renderer to obtain the URL for a single pixel transparent image suitable for stretching to fill areas of labels for spacing.
static String	TRANSPARENT_POINT_IMG Deprecated. Defines the property name used within the configuration system to obtain the URL for the tree's default TRANSPARENT_POINT image.

Constructor Summary

Images()
Deprecated.

Method Summary

static Map

getDefaultSet() Deprecated. Builds a Map of the default images used in the tree control that can then be customized by an application to override some or all of the URLs for the images.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FOLDER_OPEN

public static final String FOLDER_OPEN

Deprecated.

Represents the key used by the renderer to obtain the URL for the open container node in the tree. A typical default image for containers is a folder.

See Also:

Constant Field Values

FOLDER_OPEN_IMG

public static final String FOLDER_OPEN_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default FOLDER_OPEN image.

FOLDER_CLOSED

public static final String FOLDER_CLOSED

Deprecated.

Represents the key used by the renderer to obtain the URL for the closed container node in the tree.

See Also:

Constant Field Values

FOLDER_CLOSED_IMG

public static final String FOLDER_CLOSED_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default FOLDER_CLOSED image.

START_OF_CONTAINER

public static final String START_OF_CONTAINER

Deprecated.

Represents the key used by the renderer to obtain the URL for the containment start image in the tree when containment is being used. Such an image implies containment. A typical default is an open paren. These images can be used to render logical expressions via the tree renderer.

See Also:

Constant Field Values

START_OF_CONTAINER_IMG

public static final String START_OF_CONTAINER_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default START_OF_CONTAINER image.

END_OF_CONTAINER

public static final String END_OF_CONTAINER

Deprecated.

Represents the key used by the renderer to obtain the URL for the containment end image in the tree when containment is being used. A typical default is a close paren.

See Also:

Constant Field Values

END_OF_CONTAINER_IMG

public static final String END_OF_CONTAINER_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default END_OF_CONTAINER image.

MIDDLE_BRANCH_COLLAPSED

public static final String MIDDLE_BRANCH_COLLAPSED

Deprecated.

Represents the key used by the renderer to obtain the URL for the image depicting a collapsed branch point in the tree where there are additional following sibling nodes. For example:

    middleBranchCollapsed
        |            
      +---+
      | + |--- node image and label
      +---+
        |                           
        |   
 

See Also:

Constant Field Values

MIDDLE_BRANCH_COLLAPSED_IMG

public static final String MIDDLE_BRANCH_COLLAPSED_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_BRANCH_COLLAPSED image.

MIDDLE_BRANCH_EXPANDED

public static final String MIDDLE_BRANCH_EXPANDED

Deprecated.

Represents the key used by the renderer to obtain the URL for the image depicting an expanded branch point in the tree where there are additional following sibling nodes. For example:

    middleBranchExpanded
        | 
      +---+
      | - +--- node image and label
      +---+     |
        |       +-- child 
        |       |
 

See Also:

Constant Field Values

MIDDLE_BRANCH_EXPANDED_IMG

public static final String MIDDLE_BRANCH_EXPANDED_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_BRANCH_EXPANDED image.

LAST_BRANCH_COLLAPSED

public static final String LAST_BRANCH_COLLAPSED

Deprecated.

Represents the key used by the renderer to obtain the URL for the image depicting a collapsed branch point in the tree where there are no additional following sibling nodes. For example:

   lastBranchCollapsed
       |  
     +---+
     | + |--- node image and label
     +---+ 
    
 

See Also:

Constant Field Values

LAST_BRANCH_COLLAPSED_IMG

public static final String LAST_BRANCH_COLLAPSED_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_BRANCH_COLLAPSED image.

LAST_BRANCH_EXPANDED

public static final String LAST_BRANCH_EXPANDED

Deprecated.

Represents the key used by the renderer to obtain the URL for the image depicting an expanded branch point in the tree where there are no additional following sibling nodes. For example:

   lastBranchExpanded
       | 
     +---+
     | - +--- node image and label
     +---+     |
               +--- child 
               |
 

See Also:

Constant Field Values

LAST_BRANCH_EXPANDED_IMG

public static final String LAST_BRANCH_EXPANDED_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_BRANCH_EXPANDED image.

NO_BRANCH

public static final String NO_BRANCH

Deprecated.

Represents the key used by the renderer to obtain the URL for the image depicting an area of the tree not containing a branch. For example the lastBranchExpanded example has been included again below but with an empty representation of this image below the lastBranchExpanded image.

   lastBranchExpanded
       | 
     +---+
     | - +-- node image and label
     +---+     |
     +---+     +-- child
     |   |     |
     +---+     |
 

See Also:

Constant Field Values

NO_BRANCH_IMG

public static final String NO_BRANCH_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default NO_BRANCH image.

TRANSPARENT_POINT

public static final String TRANSPARENT_POINT

Deprecated.

Represents the key used by the renderer to obtain the URL for a single pixel transparent image suitable for stretching to fill areas of labels for spacing.

See Also:

Constant Field Values

TRANSPARENT_POINT_IMG

public static final String TRANSPARENT_POINT_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default TRANSPARENT_POINT image.

MIDDLE_CHILD

public static final String MIDDLE_CHILD

Deprecated.

Represents the key used by the renderer to obtain the URL for the image representing the non expandable branch of a child node with additional following sibling nodes.

   middleBranch
     |        
     +-- child image and label
     |
 

See Also:

Constant Field Values

MIDDLE_CHILD_IMG

public static final String MIDDLE_CHILD_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default MIDDLE_CHILD image.

SKIPPED_CHILD_RPT

public static final String SKIPPED_CHILD_RPT

Deprecated.

Represents the key used by the renderer to obtain the URL for a vertically repeatable version of an image representing the branch leading from the parent of an exposed child to the parent's following sibling. By using this repeatable version as a repeated background image the text in rows can wrap and the tree branches will accomodate the expansion by appearing to expand and collapse vertically as needed.

   skippedChild
     |   |
     |   +-- child of parallel branch skipped by parent's sibling branch
     |    
     +-- child's parent's following sibling
     
 

See Also:

Constant Field Values

SKIPPED_CHILD_RPT_IMG

public static final String SKIPPED_CHILD_RPT_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default SKIPPED_CHILD_RPT image.

SKIPPED_CHILD

public static final String SKIPPED_CHILD

Deprecated.

Represents the key used by the renderer to obtain the URL for an image representing the branch leading from the parent of an exposed child to the parent's following sibling. This may be the same as the repeatable version or may differ if needed.

   skippedChild
     |   |
     |   +-- child of parallel branch skipped by parent's sibling branch
     |    
     +-- child's parent's following sibling
     
 

See Also:

Constant Field Values

SKIPPED_CHILD_IMG

public static final String SKIPPED_CHILD_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default SKIPPED_CHILD image.

LAST_CHILD

public static final String LAST_CHILD

Deprecated.

Represents the key used by the renderer to obtain the URL for the branch of a non-expandable child node with no additional following sibling nodes.

   lastBranch
     |        
     +-- child image and label
     
 

See Also:

Constant Field Values

LAST_CHILD_IMG

public static final String LAST_CHILD_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default LAST_CHILD image.

SHOW_ASPECTS

public static final String SHOW_ASPECTS

Deprecated.

Represents the key used by the renderer to obtain the URL for an image used to show aspects of a node in the tree. Aspects do not receive a horizontal branch connected to the vertical child branch of a parent node thus implying that they are aspects of the parent node and not child nodes.

   an expanded middle branch
     | 
   +---+                         +------------------+
   | - +-- node image and label  | showAspectsImage |
   +---+     |                   +------------------+
     |       +-- child 
     |       |
   
 

See Also:

Constant Field Values

SHOW_ASPECTS_IMG

public static final String SHOW_ASPECTS_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default SHOW_ASPECTS image.

HIDE_ASPECTS

public static final String HIDE_ASPECTS

Deprecated.

Represents the key used by the renderer to obtain the URL for an image used to hide aspects of a node in the tree. Aspects do not receive a horizontal branch connected to the vertical child branch of a parent node thus implying that they are aspects of the parent node and not child nodes.

   an expanded middle branch
     | 
   +---+                         +------------------+
   | - +-- node image and label  | hideAspectsImage |
   +---+     | aspect 1          +------------------+
     |       | aspect 2
     |       | aspect 3
     |       +-- child 
     |       |
   
 

See Also:

Constant Field Values

HIDE_ASPECTS_IMG

public static final String HIDE_ASPECTS_IMG

Deprecated.

Defines the property name used within the configuration system to obtain the URL for the tree's default HIDE_ASPECTS image.

Constructor Detail

Images

public Images()

Deprecated.

Method Detail

getDefaultSet

public static Map getDefaultSet()

Deprecated.

Builds a Map of the default images used in the tree control that can then be customized by an application to override some or all of the URLs for the images.

Returns: