Package org.eclnt.workplace

Class WorkplaceFavorites

java.lang.Object
org.eclnt.jsfserver.managedbean.DefaultDispatchedBean
org.eclnt.workplace.WorkplaceFavorites
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
WorkplaceHistory
public class WorkplaceFavorites extends DefaultDispatchedBean implements Serializable
This class needs to be sub-classed by your implementation and needs to be registered within the workpage dispatcher of your application.
See Also:

  • Field Details

    • m_defaultImage

      protected String m_defaultImage

  • Constructor Details

    • WorkplaceFavorites

      public WorkplaceFavorites(IDispatcher dispatcher)

    • WorkplaceFavorites

      public WorkplaceFavorites(IDispatcher dispatcher, String persistId)
      When passing a persistId, then favorites automatically will be read and stored from persistence (via StreamStore.

  • Method Details

    • setDefaultImage

      public void setDefaultImage(String value)

    • getDefaultImage

      public String getDefaultImage()

    • setWithIconTexts

      public void setWithIconTexts(boolean value)

    • getWithIconTexts

      public boolean getWithIconTexts()

    • addFavoritesListener

      public void addFavoritesListener(IFavoritesListener listener)

    • removeFavoritesListener

      public void removeFavoritesListener(IFavoritesListener listener)

    • setImageWidthStr

      public void setImageWidthStr(String value)
      internal use

    • setImageHeightStr

      public void setImageHeightStr(String value)
      internal use

    • setWithIconTextStr

      public void setWithIconTextStr(String value)
      internal use

    • setRowAlignmentYStr

      public void setRowAlignmentYStr(String value)
      internal use

    • setObjectBinding

      public void setObjectBinding(String value)

    • getObjectBinding

      public String getObjectBinding()

    • setPane

      public void setPane(org.eclnt.jsfserver.elements.impl.PANEComponent pane)
      Internal use.

    • setIconDirectoryPath

      public void setIconDirectoryPath(String path)
      Sets the directory path for the icons that are selectable by the user. Default is "/eclntjsfserver/images/". The directory path is a path inside your web application.

    • addFavorite

      public void addFavorite(WorkpageStartInfo favoriteInfo)
      Adds a favorite to the favorite bar.

    • getFis

      public List<WorkplaceFavorites.FavoriteInternalInfo> getFis()
      Internal use.

    • getFavorites

      public List<WorkpageStartInfo> getFavorites()
      Favorites as list - do not modify this list!

    • onPaneAction

      public void onPaneAction(javax.faces.event.ActionEvent event)
      Internal use.

    • getFaovriteInfos

      public List<WorkpageStartInfo> getFaovriteInfos()
      Returns back the current favorite infos that are kept.

    • loadFromPersistence

      public void loadFromPersistence(String persistId)
      Read workplace favorites from persistence - and from now on also saves changes automatically. You may also use this method for reloading the workplace favorites persistent information.

    • updateButtonTagBeforeComponentCreation

      protected void updateButtonTagBeforeComponentCreation(BaseComponentTag buttonTag)
      The button tag is passed so that you can update attributes that influence the look and feel of a button tag instance, representing one favorite-button.

    • updatePane

      protected void updatePane()
      Transfers the favorite info into a compoent tree, that is plugged below the pane element coming from the layout.

    • notifyFavoritesListeners

      protected void notifyFavoritesListeners()

    • loadFromPersistId

      protected void loadFromPersistId(String persistId)

    • save

      protected void save(String persistId)