Class StateIconAttributes
- All Implemented Interfaces:
Serializable
,org.apache.wicket.model.IDetachable
,org.apache.wicket.util.io.IClusterable
,IObservable
Standard attributes of a hippostd:publishable document. Figures out what CSS classes, summary and icon should be used to represent the state. Can be used with handles, documents and (document) versions.
The org.hippoecm.frontend.plugins.cms.browse.list.DefaultListColumnProviderPlugin adds a
ListColumn
to display the documents in the "Document Area", that lists documents inside folders.
This ListColumn
in its turn:
- allows attribute modifieds to be added, see
ListColumn.setAttributeModifier(AbstractListAttributeModifier)
- allows a
IListCellRenderer
to be set, seeListColumn.setRenderer(IListCellRenderer)
- adds
ListCell
's
The StateIconAttributeModifier
using this class set the title attribute (tooltip in this case) and the
css class.
The DocumentIconAndStateRenderer
uses getIcons()
to add and update the icons.
The handle, document or document revision is observed, see IObservable
by the observers of ListCell
, so that any modification
updates the css class, tooltip and icons.
In case of a handle, the draft variant is observed if it exists. If the stateSummary or the retainable property changes, the icon and toolip are updated. If no draft variant exists the published or unpublished variant is observed.
If the nodeModel
, see constructor argument StateIconAttributes(JcrNodeModel)
refers to a revision, the frozen node of the revision is used.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
detach()
Icon[]
getIcons()
void
setObservationContext
(IObservationContext<? extends IObservable> context) Before observation is started on the observable, an observation context is injected by the observer registry.void
When the firstIObserver
of this observable is registered with the observer registry, observation is started.void
When the lastIObserver
unregisters, observation is stopped.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hippoecm.frontend.model.event.IObservable
equals, hashCode
-
Field Details
-
DRAFT_CHANGES
- See Also:
-
-
Constructor Details
-
StateIconAttributes
-
-
Method Details
-
getSummary
-
getCssClass
-
getIcons
-
detach
public void detach()- Specified by:
detach
in interfaceorg.apache.wicket.model.IDetachable
-
setObservationContext
Description copied from interface:IObservable
Before observation is started on the observable, an observation context is injected by the observer registry. This context can be used to notify listeners.- Specified by:
setObservationContext
in interfaceIObservable
-
startObservation
public void startObservation()Description copied from interface:IObservable
When the firstIObserver
of this observable is registered with the observer registry, observation is started. Implementations must notify observers until observation is stopped.An implementation should register listeners with external data sources, when appropriate. It is possible for an observable to register as an observer for another observable.
- Specified by:
startObservation
in interfaceIObservable
-
stopObservation
public void stopObservation()Description copied from interface:IObservable
When the lastIObserver
unregisters, observation is stopped. Any listeners or observers registered by the observable must be unregistered by the implementation.- Specified by:
stopObservation
in interfaceIObservable
-