com.webmethods.portal.framework.mech.theme

Interface ISkinComponentMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface ISkinComponentMechanics
extends IMechanics

Mechanics for drawing skin components.

Method Summary

Modifier and Type	Method and Description
boolean	canListPageBackward(INBSPage page, IPagingCookie cookie) True if the list can page back.
boolean	canListPageForward(INBSPage page, IPagingCookie cookie) True if the list can page forward.
boolean	canListSortByColumn(INBSPage page, IPagingCookie cookie) True if current column is sortable.
int	getListCurrentPage(INBSPage page, IPagingCookie cookie) Gets the current page.
int	getListFirstPage(INBSPage page, IPagingCookie cookie) Gets the first page in the current range (the range around the current page).
int	getListLastPage(INBSPage page, IPagingCookie cookie) Gets the last page in the current range (the range around the current page).
IViewableMechanics	getTitlebarMechanics(INBSPage page, IURI uri) Gets the titlebar mechanics for the given uri
IURI	getTitlebarURI(INBSPage page, IPresentationData pdo) Gets the uri for the titlebar.
IView	getTitlebarView(INBSPage page, IURI uri, IViewableMechanics mechanics, IPrincipalData auth) Gets the view for the titlebar.
String	getTitlebarViewLockedBy(INBSPage page, IViewableMechanics mechanics, IView view) Gets the id of the user who's locked the titlebar resource.
String	getTitlebarWidgetPixelWidth(INBSPage page, String pxWidth, IBrowserBean browser) Calculates the width of the widget.
boolean	isListSortCurrent(INBSPage page, IPagingCookie cookie) True if current column is the currently sorted column.
boolean	isListSortTogglable(INBSPage page, IPagingCookie cookie) True if current column sorting is togglable (ascending or descending).
boolean	isTitlebarViewLocked(INBSPage page, IViewableMechanics mechanics, IView view) True if the titlebar resource is locked.
boolean	isTitlebarViewVersioned(INBSPage page, IViewableMechanics mechanics, IView view) True if the titlebar resource is versioned.
void	printListEnd(INBSPage page, IPagingCookie cookie) Prints the list end in html.
void	printListPageBackwardLink(INBSPage page, IPagingCookie cookie) Prints the page backward link in html.
void	printListPageForwardLink(INBSPage page, IPagingCookie cookie) Prints the page forkward link in html.
void	printListPageLink(INBSPage page, IPagingCookie cookie, int pageNumber) Prints the jump to page link in html.
void	printListQuery(INBSPage page, IPagingCookie cookie) Prints the list query string in html.
void	printListSortLink(INBSPage page, IPagingCookie cookie) Prints the current columns sort link.
void	printListStart(INBSPage page, IPagingCookie cookie) Prints the list start in html.
void	printListTotal(INBSPage page, IPagingCookie cookie) Prints the list total in html.
boolean	showListNextPrev(INBSPage page, IPagingCookie cookie) True if the list should show the next/prev links.
boolean	showListPage(INBSPage page, IPagingCookie cookie) True if the list should show the page info (ie ...
boolean	showListPosition(INBSPage page, IPagingCookie cookie) True if the list should show the position info (ie 1-10 of 100).
boolean	showListSearch(INBSPage page, IPagingCookie cookie) True if the list should show the search box.
boolean	showSubmitCancel(INBSPage page) True if submit block should show Cancel button.
boolean	showSubmitFinish(INBSPage page) True if submit block should show Finish button.
boolean	showSubmitNext(INBSPage page) True if submit block should show Next button.
boolean	showSubmitPrev(INBSPage page) True if submit block should show Previous button.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Method Detail

getTitlebarURI

IURI getTitlebarURI(INBSPage page,
                    IPresentationData pdo)
             throws PortalException

Gets the uri for the titlebar.

Parameters:

page - the current NBSP page

pdo - the current PresentationData object

Returns:

the uri for the titlebar.

Throws:

PortalException - if there is an error getting the titlebar URI

getTitlebarMechanics

IViewableMechanics getTitlebarMechanics(INBSPage page,
                                        IURI uri)
                                 throws PortalException

Gets the titlebar mechanics for the given uri

Parameters:

page - the current NBSP page

uri - the IURI to lookup the titlebar mechanics for.

Returns:

the titlebar mechanics for the given uri

Throws:

PortalException - if there is an error getting the titlebar mechanics

getTitlebarView

IView getTitlebarView(INBSPage page,
                      IURI uri,
                      IViewableMechanics mechanics,
                      IPrincipalData auth)
               throws PortalException

Gets the view for the titlebar.

Parameters:

page - the current NBSP page

mechanics - the titlebar mechanics

auth - the principal data about the current user

Returns:

the view for the titlebar.

Throws:

PortalException - if there is an error getting the titlebar view

isTitlebarViewVersioned

boolean isTitlebarViewVersioned(INBSPage page,
                                IViewableMechanics mechanics,
                                IView view)
                         throws PortalException

True if the titlebar resource is versioned.

Parameters:

page - the current NBSP page

mechanics - the titlebar mechanics

view - the titlebar view

Returns:

true if the titlebar resource is versioned, false otherwise.

Throws:

PortalException - if there is an error determining if the titlebar view is versioned

isTitlebarViewLocked

boolean isTitlebarViewLocked(INBSPage page,
                             IViewableMechanics mechanics,
                             IView view)
                      throws PortalException

True if the titlebar resource is locked.

Parameters:

page - the current NBSP page

mechanics - the titlebar mechanics

view - the titlebar view

Returns:

true if teh titlebar resource is locked, false otherwise

Throws:

PortalException - if there is an error determining if the titlebar view is locked

getTitlebarViewLockedBy

String getTitlebarViewLockedBy(INBSPage page,
                               IViewableMechanics mechanics,
                               IView view)
                        throws PortalException

Gets the id of the user who's locked the titlebar resource.

Parameters:

page - the current NBSP page

mechanics - the titlebar mechanics

view - the titlebar view

Returns:

the id of the user who's locked the titlebar resource.

Throws:

PortalException - if there is an error determining who the titlebar view is locked by

getTitlebarWidgetPixelWidth

String getTitlebarWidgetPixelWidth(INBSPage page,
                                   String pxWidth,
                                   IBrowserBean browser)
                            throws PortalException

Calculates the width of the widget.

Parameters:

page - the current NBSP page

pxWidth - the pxWidth to use in the calculation

browser - the BrowserBean for the current client

Returns:

the width of the widget.

Throws:

PortalException - if there is an error calculating the width of the widget

showSubmitPrev

boolean showSubmitPrev(INBSPage page)
                throws PortalException

True if submit block should show Previous button.

Parameters:

page - the current NBSP page

Returns:

true if submit block should show Previous button, false otherwise

Throws:

PortalException - if there is an error determining if the previous button should be shown

showSubmitNext

boolean showSubmitNext(INBSPage page)
                throws PortalException

True if submit block should show Next button.

Parameters:

page - the current NBSP page

Returns:

true if submit block should show Next button, false otherwise

Throws:

PortalException - if there is an error determining if the next button should be shown

showSubmitFinish

boolean showSubmitFinish(INBSPage page)
                  throws PortalException

True if submit block should show Finish button.

Parameters:

page - the current NBSP page

Returns:

true if submit block should show Finish button, false otherwise

Throws:

PortalException - if there is an error determining if the finish button should be shown

showSubmitCancel

boolean showSubmitCancel(INBSPage page)
                  throws PortalException

True if submit block should show Cancel button.

Parameters:

page - the current NBSP page

Returns:

true if submit block should show Cancel button, false otherwise

Throws:

PortalException - if there is an error determining if the cancel button should be shown

showListSearch

boolean showListSearch(INBSPage page,
                       IPagingCookie cookie)
                throws PortalException

True if the list should show the search box.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list should show the search box

Throws:

PortalException - if there is an error determining if the list search box should be shown

showListPosition

boolean showListPosition(INBSPage page,
                         IPagingCookie cookie)
                  throws PortalException

True if the list should show the position info (ie 1-10 of 100).

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list should show the position info

Throws:

PortalException - if there is an error determining if the list position info should be shown

showListNextPrev

boolean showListNextPrev(INBSPage page,
                         IPagingCookie cookie)
                  throws PortalException

True if the list should show the next/prev links.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list should show the next/prev links

Throws:

PortalException - if there is an error determining if the list next/prev links should be shown

showListPage

boolean showListPage(INBSPage page,
                     IPagingCookie cookie)
              throws PortalException

True if the list should show the page info (ie ... 5 6 7 _8_ 9 10 11 ...).

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list should show the page info

Throws:

PortalException - if there is an error determining if the list page info should be shown

printListQuery

void printListQuery(INBSPage page,
                    IPagingCookie cookie)
             throws PortalException,
                    IOException

Prints the list query string in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list query

IOException

printListStart

void printListStart(INBSPage page,
                    IPagingCookie cookie)
             throws PortalException,
                    IOException

Prints the list start in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list start

IOException

printListEnd

void printListEnd(INBSPage page,
                  IPagingCookie cookie)
           throws PortalException,
                  IOException

Prints the list end in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list end

IOException

printListTotal

void printListTotal(INBSPage page,
                    IPagingCookie cookie)
             throws PortalException,
                    IOException

Prints the list total in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list total

IOException

canListPageBackward

boolean canListPageBackward(INBSPage page,
                            IPagingCookie cookie)
                     throws PortalException

True if the list can page back.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list can page backwards

Throws:

PortalException - if there is an error determining if the list can page backwards

canListPageForward

boolean canListPageForward(INBSPage page,
                           IPagingCookie cookie)
                    throws PortalException

True if the list can page forward.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if the list can page forwards

Throws:

PortalException - if there is an error determining if the list can page forwards

printListPageBackwardLink

void printListPageBackwardLink(INBSPage page,
                               IPagingCookie cookie)
                        throws PortalException,
                               IOException

Prints the page backward link in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list page backward link

IOException

printListPageForwardLink

void printListPageForwardLink(INBSPage page,
                              IPagingCookie cookie)
                       throws PortalException,
                              IOException

Prints the page forkward link in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list page forward link

IOException

getListFirstPage

int getListFirstPage(INBSPage page,
                     IPagingCookie cookie)
              throws PortalException

Gets the first page in the current range (the range around the current page).

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

the first page in the current range (the range around the current page)

Throws:

PortalException - if there is an error getting the list first page

getListLastPage

int getListLastPage(INBSPage page,
                    IPagingCookie cookie)
             throws PortalException

Gets the last page in the current range (the range around the current page).

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

the last page in the current range (the range around the current page)

Throws:

PortalException - if there is an error getting the list last page

getListCurrentPage

int getListCurrentPage(INBSPage page,
                       IPagingCookie cookie)
                throws PortalException

Gets the current page.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

the current page

Throws:

PortalException - if there is an error getting the list current page

printListPageLink

void printListPageLink(INBSPage page,
                       IPagingCookie cookie,
                       int pageNumber)
                throws PortalException,
                       IOException

Prints the jump to page link in html.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list page link

IOException

canListSortByColumn

boolean canListSortByColumn(INBSPage page,
                            IPagingCookie cookie)
                     throws PortalException

True if current column is sortable.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if current column is sortable

Throws:

PortalException - if there is an error determining if the current column is sortable

isListSortCurrent

boolean isListSortCurrent(INBSPage page,
                          IPagingCookie cookie)
                   throws PortalException

True if current column is the currently sorted column.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if current column is the currently sorted column

Throws:

PortalException - if there is an error determining if the current column is the sorted column

isListSortTogglable

boolean isListSortTogglable(INBSPage page,
                            IPagingCookie cookie)
                     throws PortalException

True if current column sorting is togglable (ascending or descending).

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Returns:

true if current column sorting is togglable (ascending or descending)

Throws:

PortalException - if there is an error determining if the current column sorting is togglable

printListSortLink

void printListSortLink(INBSPage page,
                       IPagingCookie cookie)
                throws PortalException,
                       IOException

Prints the current columns sort link.

Parameters:

page - the current NBSP page

cookie - the paging cookie for the list

Throws:

PortalException - if there is an error printing the list sort link

IOException