Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal
Interface IAnchoringSerializer

All Known Implementing Classes:
  BaseMarkupSerializer, CachingHTMLSerializer, CachingXHTMLSerializer, HTMLSerializer, TextSerializer, XHTMLSerializer, XMLSerializer

    public interface IAnchoringSerializer

An anchoring serializer allows an external client to control its anchor identifier. When set (when it isn't null), it should append this anchor identifier to its URLs so that when a user clicks on one of the URLs, the user's browser will jump down to the anchor. The original use of this interface will be to make it possible to add anchors to channel links and forms where the anchor is set to the channel's subscribtion ID.

Version:
  $Revision: 1.2 $
Author:
  Ken Weiner, kweiner@unicon.net

Method Summary
`void` | `startAnchoring(java.lang.String anchorId)` Signify that the serializer should begin to append the anchor ID to URLs of its choosing.
`void` | `stopAnchoring()` Signify that anchoring is no longer desired by the serializer.

Method Detail

### startAnchoring

    void startAnchoring(java.lang.String anchorId)

  Signify that the serializer should begin to append the anchor ID to URLs of its choosing.

  Parameters:
    `anchorId` - the anchor identifier

### stopAnchoring

    void stopAnchoring()

  Signify that anchoring is no longer desired by the serializer.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD