Package io.guise.framework.platform.web
Class AbstractWebMenuDepictor<C extends Menu>
java.lang.Object
io.guise.framework.platform.AbstractDepictor<C>
io.guise.framework.platform.AbstractComponentDepictor<C>
io.guise.framework.platform.web.AbstractWebComponentDepictor<C>
io.guise.framework.platform.web.AbstractWebLayoutComponentDepictor<C>
io.guise.framework.platform.web.AbstractWebMenuDepictor<C>
- Type Parameters:
C
- The type of component being depicted.
- All Implemented Interfaces:
ComponentDepictor<C>
,Depictor<C>
,WebComponentDepictor<C>
,WebDepictor<C>
- Direct Known Subclasses:
WebAccordionMenuDepictor
,WebDropMenuDepictor
public abstract class AbstractWebMenuDepictor<C extends Menu>
extends AbstractWebLayoutComponentDepictor<C>
Abstract strategy for rendering a menu.
- Author:
- Garret Wilson
-
Nested Class Summary
Nested classes/interfaces inherited from class io.guise.framework.platform.AbstractComponentDepictor
AbstractComponentDepictor.DepictedCompositeComponentListener
Nested classes/interfaces inherited from class io.guise.framework.platform.AbstractDepictor
AbstractDepictor.DepictedPropertyChangeListener
-
Field Summary
Fields inherited from class io.guise.framework.platform.web.AbstractWebLayoutComponentDepictor
COLUMN_REGION_CLASSES, ROW_REGION_CLASSES
Fields inherited from class io.guise.framework.platform.web.AbstractWebComponentDepictor
BODY_END_PATTERN, BODY_START_PATTERN
Fields inherited from class io.guise.framework.platform.AbstractComponentDepictor
childPropertyChangeListener
Fields inherited from interface io.guise.framework.platform.Depictor
GENERAL_PROPERTY
-
Constructor Summary
ConstructorDescriptionDefault constructor with no element representation.AbstractWebMenuDepictor
(URI namespaceURI, String localName) Element namespace and local name constructor that doesn't create an empty element, even if there is no content.AbstractWebMenuDepictor
(URI namespaceURI, String localName, boolean isEmptyElementAllowed) Element namespace and local name constructor. -
Method Summary
Modifier and TypeMethodDescriptiongetBaseStyleIDs
(String prefix, String suffix) Retrieves the base style IDs for the given component.void
processEvent
(PlatformEvent event) Processes an event from the platform.Methods inherited from class io.guise.framework.platform.web.AbstractWebLayoutComponentDepictor
beginRegion, beginRegion, depictChildren, getAlign, updateFlowChildView
Methods inherited from class io.guise.framework.platform.web.AbstractWebComponentDepictor
addFlowStyleIDs, decorateID, depict, depictBegin, depictBody, depictEnd, getBackgroundColor, getBodyStyleIDs, getBodyStyles, getColor, getDepictContext, getDepictName, getLabelStyles, getLabelStyles, getLabelStyles, getLocalName, getNamespaceURI, getOuterStyles, getPlatform, hasLabelContent, hasLabelContent, hasLabelContent, hasLabelContent, isEmptyElementAllowed, isMouseListener, writeBodyIDClassAttributes, writeClassAttribute, writeDirectionAttribute, writeDirectionAttribute, writeErrorMessage, writeFloatClear, writeIDAttribute, writeIDClassAttributes, writeLabel, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeParameterInputs, writeStyleAttribute, writeText
Methods inherited from class io.guise.framework.platform.AbstractComponentDepictor
depictChild, depictedObjectPropertyChange, getDepictedCompositeComponentListener, getErrorMessage, installed, uninstalled
Methods inherited from class io.guise.framework.platform.AbstractDepictor
getDepictedObject, getDepictedPropertyChangeListener, getIgnoredProperties, getModifiedProperties, getSession, isDepicted, setDepicted, setPropertyModified
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.guise.framework.platform.Depictor
getDepictedObject, getSession, installed, isDepicted, setDepicted, uninstalled
-
Constructor Details
-
AbstractWebMenuDepictor
public AbstractWebMenuDepictor()Default constructor with no element representation. -
AbstractWebMenuDepictor
Element namespace and local name constructor that doesn't create an empty element, even if there is no content.- Parameters:
namespaceURI
- The URI of the XML namespace of the element, ornull
if there is no namespace.localName
- The local name of the element with no prefix, ornull
if this component should not be rendered as an element.
-
AbstractWebMenuDepictor
Element namespace and local name constructor.- Parameters:
namespaceURI
- The URI of the XML namespace of the element, ornull
if there is no namespace.localName
- The local name of the element with no prefix, ornull
if this component should not be rendered as an element.isEmptyElementAllowed
- Whether an empty element can be created if there is no content.
-
-
Method Details
-
processEvent
Processes an event from the platform.- Specified by:
processEvent
in interfaceDepictor<C extends Menu>
- Overrides:
processEvent
in classAbstractComponentDepictor<C extends Menu>
- Parameters:
event
- The event to be processed.- Throws:
IllegalArgumentException
- if the given event is a relevantDepictEvent
with a source of a different depicted object.
-
getBaseStyleIDs
Retrieves the base style IDs for the given component.This version returns the default style ID and the specified component style ID, if any.
If the component is
Selectable
and is selected, theGuiseCSSStyleConstants.SELECTED_CLASS
is returned.This version adds attributes based upon the menu axis and orientation, as well as whether the menu is open and/or in a rollover state.
- Overrides:
getBaseStyleIDs
in classAbstractWebComponentDepictor<C extends Menu>
- Parameters:
prefix
- The prefix that needs to be added to each, ornull
if there is no prefix to add.suffix
- The suffix that needs to be added to each, ornull
if there is no suffix to add.- Returns:
- The base style IDs for the component.
-