com.sun.rave.web.ui.component
Class LinkBase

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended bycom.sun.rave.web.ui.component.LinkBase
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
Link

public abstract class LinkBase
extends javax.faces.component.UIComponentBase

Use the ui:link tag to insert header references to other documents related to this HTML page. The ui:link tag must be used inside the ui:head tag, and can be used multiple times for references to multiple documents. A common use for the ui:link tag is to link to an external stylesheet, but it can also be used to provide information about the document's relationship to other documents.  There are a number of useful defaults making it simpler to specify an HTML link using this tag.


HTML Elements and Layout

The rendered HTML page contains <link> element, along with any attributes specified through the ui:link tag attributes. 

Theme Identifiers

None.

Client Side Javascript Functions

None.

Example

Example 1: Create a context relative link to a stylesheet

<ui:page>
    <ui:html>
        <ui:head id="blah" title="hyperlink test page">
           <ui:link url="/context-relative-path/tomyfile/stylesheet.css">
        </ui:head>
        <ui:body>
        </ui:body>
    </ui:html>
</ui:page>

Auto-generated component class. Do NOT modify; all changes will be lost!


Constructor Summary
LinkBase()
          Construct a new LinkBase.
 
Method Summary
 java.lang.String getCharset()
          Defines the character encoding (charset) of the target URL.
 java.lang.String getFamily()
          Return the family for this component.
 java.lang.String getMedia()
          Specifies the type of display device for which the referenced document is designed.
 java.lang.String getRel()
          Defines the relationship between the current document and the targeted document.
 java.lang.String getType()
          Specifies the MIME type of the target resource.
 java.lang.String getUrl()
          The absolute or relative target URL of the resource.
 java.lang.String getUrlLang()
          Defines the ISO language code of the human language used in the target URL file.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
          Restore the state of this component.
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
          Save the state of this component.
 void setCharset(java.lang.String charset)
          Defines the character encoding (charset) of the target URL.
 void setMedia(java.lang.String media)
          Specifies the type of display device for which the referenced document is designed.
 void setRel(java.lang.String rel)
          Defines the relationship between the current document and the targeted document.
 void setType(java.lang.String type)
          Specifies the MIME type of the target resource.
 void setUrl(java.lang.String url)
          The absolute or relative target URL of the resource.
 void setUrlLang(java.lang.String urlLang)
          Defines the ISO language code of the human language used in the target URL file.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinkBase

public LinkBase()

Construct a new LinkBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.


getCharset

public java.lang.String getCharset()

Defines the character encoding (charset) of the target URL. Default value is "ISO-8859-1".


setCharset

public void setCharset(java.lang.String charset)

Defines the character encoding (charset) of the target URL. Default value is "ISO-8859-1".

See Also:
getCharset()

getMedia

public java.lang.String getMedia()

Specifies the type of display device for which the referenced document is designed. The media attribute is useful for specifying different stylesheets for print and viewing on a screen. The default value is "screen".


setMedia

public void setMedia(java.lang.String media)

Specifies the type of display device for which the referenced document is designed. The media attribute is useful for specifying different stylesheets for print and viewing on a screen. The default value is "screen".

See Also:
getMedia()

getRel

public java.lang.String getRel()

Defines the relationship between the current document and the targeted document. Default is "stylesheet". Other possible values are described at w3.org.


setRel

public void setRel(java.lang.String rel)

Defines the relationship between the current document and the targeted document. Default is "stylesheet". Other possible values are described at w3.org.

See Also:
getRel()

getType

public java.lang.String getType()

Specifies the MIME type of the target resource. Default is: "text/css"


setType

public void setType(java.lang.String type)

Specifies the MIME type of the target resource. Default is: "text/css"

See Also:
getType()

getUrl

public java.lang.String getUrl()

The absolute or relative target URL of the resource.


setUrl

public void setUrl(java.lang.String url)

The absolute or relative target URL of the resource.

See Also:
getUrl()

getUrlLang

public java.lang.String getUrlLang()

Defines the ISO language code of the human language used in the target URL file. For example, valid values might be en, fr, es.


setUrlLang

public void setUrlLang(java.lang.String urlLang)

Defines the ISO language code of the human language used in the target URL file. For example, valid values might be en, fr, es.

See Also:
getUrlLang()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.


saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.