| |
|
| java.lang.Object com.salmonllc.html.HtmlComponent com.salmonllc.html.HtmlContainer com.salmonllc.html.HtmlBackLink
HtmlBackLink | public class HtmlBackLink extends HtmlContainer implements PageListener(Code) | | This type gives you the ability to put a back link on a page and setup the rules for when and where it goes back.
|
Constructor Summary | |
public | HtmlBackLink(HtmlPage p) Simple Constructor. | public | HtmlBackLink(String name, HtmlPage p) Constructor. | public | HtmlBackLink(String name, String backLinkText, HtmlPage p) Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. | public | HtmlBackLink(String name, String backLinkText, String backLinkFont, HtmlImage backLinkImage, HtmlPage p) Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. | public | HtmlBackLink(String name, String backLinkText, HtmlImage backLinkImage, HtmlPage p) Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. |
HtmlBackLink | public HtmlBackLink(HtmlPage p)(Code) | | Simple Constructor.
Parameters: page - HtmlPage reference. |
HtmlBackLink | public HtmlBackLink(String name, HtmlPage p)(Code) | | Constructor.
Parameters: name - Name of back link. Parameters: page - HtmlPage reference. |
HtmlBackLink | public HtmlBackLink(String name, String backLinkText, HtmlPage p)(Code) | | Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. if null is passed in 'Return' is provided. Parameters: page - HtmlPage reference. |
HtmlBackLink | public HtmlBackLink(String name, String backLinkText, String backLinkFont, HtmlImage backLinkImage, HtmlPage p)(Code) | | Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. if null is passed in 'Return' is provided. Parameters: backLinkFont - This allows you to provide a link font otherwise the default LinkFont is used. Parameters: backLinkImage - HtmlImage reference to be used as a back image. Parameters: page - HtmlPage reference. |
HtmlBackLink | public HtmlBackLink(String name, String backLinkText, HtmlImage backLinkImage, HtmlPage p)(Code) | | Constructor.
Parameters: name - Name of back link. Parameters: backLinkText - Text to put in link. if null is passed in 'Return' is provided. Parameters: backLinkImage - HtmlImage reference to be used as a back image. Parameters: page - HtmlPage reference. |
addBackLinkExclusionURL | public void addBackLinkExclusionURL(String URL)(Code) | | This method adds a URL to the list of places you WOULD NOT like to go back to.
Parameters: URL - java.lang.String |
addValidBackLinkURL | public void addValidBackLinkURL(String URL)(Code) | | This method adds a URL to the list of places you WOULD like to go back to.
Parameters: URL - java.lang.String |
getBackLinkHref | public String getBackLinkHref()(Code) | | This method allows you to get the current back link href. This is helpfull if you have to add parameters to your back link.
java.lang.String |
getRefererHref | public String getRefererHref()(Code) | | This method allows you to get the refering page href.
java.lang.String |
removeBackLinkExclusionURL | public void removeBackLinkExclusionURL(String URL)(Code) | | This method will remove a URL from the list of place you WOULD NOT like to go back to.
Parameters: URL - java.lang.String |
removeValidBackLinkURL | public void removeValidBackLinkURL(String URL)(Code) | | This method removes a URL from the list of places you WOULD like to go back to.
Parameters: URL - java.lang.String |
setBackLinkText | public void setBackLinkText(String text)(Code) | | This method will set the back link text for you. This is helpfull when the backlink should say one thing in one mode and another in another mode.
|
setCheckExclusions | public void setCheckExclusions(boolean toggle)(Code) | | This method sets whether back link exclusions are checked.
default is CHECK_EXCLUSIONS = false
|
setCheckValid | public void setCheckValid(boolean toggle)(Code) | | This method sets whether valid back links are checked.
default is CHECK_VALID = false
|
setOverRideBackLinkHref | public void setOverRideBackLinkHref(String href)(Code) | | This method lets you override where the back link will go.
|
setOverRideRefer | public void setOverRideRefer(boolean toggle)(Code) | | This method sets whether the back link should look at the override backlink.
default is OVERRIDE_REFER = false
|
setStripParams | public void setStripParams(boolean toggle)(Code) | | This method sets whether we should strip parameters when figureing out default back links.
default is STRIP_PARAMS = true
|
|
|
|