Author: julien(a)jboss.com Date: 2008-03-28 21:04:13 -0400 (Fri, 28 Mar 2008) New Revision: 10412 Added: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/ui/ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/ui/UIObjectImpl.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIAction.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContainer.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContext.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIObject.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIWindow.java Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/CreateDiffPhase.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/ObjectVisit.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/CreateUpdatePhase.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/ObjectUpdate.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortContext.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortScope.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/CustomScope.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectNode.java branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectTree.java Log: move differnet obejct subclasses to a ui package for better visibility Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/CreateDiffPhase.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/CreateDiffPhase.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/CreateDiffPhase.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -25,7 +25,7 @@ import org.jboss.portal.presentation.model2.ViewPortScope; import org.jboss.portal.presentation.model2.ViewPortContext; import org.jboss.portal.presentation.model2.ObjectTraversalType; -import org.jboss.portal.presentation.impl.model2.UIObjectImpl; +import org.jboss.portal.presentation.impl.model2.ui.UIObjectImpl; import org.jboss.portal.presentation.model.state.structural.StructuralStateContext; import org.jboss.portal.presentation.model.state.structural.StructuralObject; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/ObjectVisit.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/ObjectVisit.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/diff/ObjectVisit.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.presentation.impl.model2.diff; -import org.jboss.portal.presentation.impl.model2.UIObjectImpl; +import org.jboss.portal.presentation.impl.model2.ui.UIObjectImpl; /** * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/ui/UIObjectImpl.java (from rev 10406, branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/UIObjectImpl.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/ui/UIObjectImpl.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/ui/UIObjectImpl.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,110 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2008, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.impl.model2.ui; + +import org.jboss.portal.presentation.model2.ui.UIObject; +import org.jboss.portal.presentation.model.state.StateException; +import org.jboss.portal.presentation.model.state.structural.StructuralObject; +import org.jboss.portal.presentation.impl.model2.UIObjectRef; + +import java.util.Map; +import java.util.Set; + +/** + * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +public class UIObjectImpl implements UIObject +{ + + /** . */ + public StructuralObject structuralObject; + + /** We keep track of what was loaded by the scope. */ + public Map<String, UIObjectRef> childRefs; + + public UIObjectImpl(StructuralObject structuralObject) + { + this.structuralObject = structuralObject; + } + + public String getId() + { + return structuralObject.getId(); + } + + public String getName() + { + return structuralObject.getState().getName(); + } + + public <T> T getProperty(String propertyName, Class<T> propertyType) throws IllegalArgumentException, StateException + { + return safeCast(getProperty(propertyName), propertyType); + } + + public Set<String> getPropertyNames() + { + return structuralObject.getState().getProperties().keySet(); + } + + public Object getProperty(String propertyName) throws IllegalArgumentException, StateException + { + if (propertyName == null) + { + throw new IllegalArgumentException(); + } + return structuralObject.getState().getProperties().get(propertyName); + } + + /** + * Attempt to cast the value argument to the provided type argument. If the value argument type is assignable + * to the provided type, the value is returned, otherwise if it is not or the value is null, null is returned. + * + * @param value the value to cast + * @param type the type to downcast + * @return the casted value or null + */ + private <T> T safeCast(Object value, Class<T> type) + { + if (type == null) + { + throw new IllegalArgumentException(); + } + if (value == null) + { + return null; + } + else + { + if (type.isAssignableFrom(value.getClass())) + { + return type.cast(value); + } + else + { + return null; + } + } + } +} \ No newline at end of file Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/CreateUpdatePhase.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/CreateUpdatePhase.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/CreateUpdatePhase.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -25,7 +25,7 @@ import org.jboss.portal.presentation.model2.ViewPortContext; import org.jboss.portal.presentation.impl.model2.diff.ObjectVisit; import org.jboss.portal.presentation.impl.model2.diff.ChildrenVisit; -import org.jboss.portal.presentation.impl.model2.UIObjectImpl; +import org.jboss.portal.presentation.impl.model2.ui.UIObjectImpl; import org.jboss.portal.presentation.impl.model2.UIObjectRef; import java.util.List; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/ObjectUpdate.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/ObjectUpdate.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/impl/model2/update/ObjectUpdate.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.presentation.impl.model2.update; -import org.jboss.portal.presentation.impl.model2.UIObjectImpl; +import org.jboss.portal.presentation.impl.model2.ui.UIObjectImpl; import org.jboss.portal.presentation.impl.model2.UIObjectRef; import org.jboss.portal.presentation.model2.ViewPortContext; import org.jboss.portal.presentation.model.state.structural.StructuralObject; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortContext.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortContext.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortContext.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -22,6 +22,8 @@ ******************************************************************************/ package org.jboss.portal.presentation.model2; +import org.jboss.portal.presentation.model2.ui.UIObject; + /** * This interface defines read-write access to the structural information of a viewport. * Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortScope.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortScope.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ViewPortScope.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -22,6 +22,8 @@ ******************************************************************************/ package org.jboss.portal.presentation.model2; +import org.jboss.portal.presentation.model2.ui.UIObject; + /** * Defines the scope of a viewport. This interface is separated from the viewport context in order to * really affirm the split between the concern between the scope implementation that is used by the viewport Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIAction.java (from rev 10411, branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/UIAction.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIAction.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIAction.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,57 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.model2.ui; + +import org.jboss.portal.presentation.model.UIObject; + +/** + * An action that can be triggered. + * + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +public interface UIAction extends UIObject +{ + + /** + * Returns the action display name. + * + * @return the display name + */ + String getDisplayName(); + + /** + * Returns the action icon URL. + * + * @return the icon URL + */ + String getIconURL(); + + /** + * Returns the action URL. + * + * @return the url + */ + String getURL(); + +} \ No newline at end of file Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContainer.java (from rev 10411, branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/UIContainer.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContainer.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContainer.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,31 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.model2.ui; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface UIContainer extends UIObject +{ +} \ No newline at end of file Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContext.java (from rev 10411, branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/UIContext.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContext.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIContext.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,31 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.model2.ui; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface UIContext extends UIObject +{ +} \ No newline at end of file Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIObject.java (from rev 10410, branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/UIObject.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIObject.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIObject.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,70 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2008, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.model2.ui; + +import org.jboss.portal.presentation.model.state.StateException; + +import java.util.Set; + +/** + * A wrapper of a structural object. The main goal of this object is to let the viewport add custom payload + * in addition of the structural state. + * + * @author <a href="mailto:julien@jboss-portal.org">Julien Viet</a> + * @version $Revision: 630 $ + */ +public interface UIObject +{ + + /** + * Returns the id. + * + * @return the id + */ + String getId(); + + /** + * Returns the name. + * + * @return the name + */ + String getName(); + + /** + * Returns a property value or null if it does not exist. + * + * @param propertyName the property name + * @param propertyType the expected property type + * @return the property value + * @throws IllegalArgumentException if any argument is null or not valid + * @throws org.jboss.portal.presentation.model.state.StateException any state exception + */ + <T> T getProperty(String propertyName, Class<T> propertyType) throws IllegalArgumentException, StateException; + + /** + * Returns the set of property names of this object + * + * @return the property names + */ + Set<String> getPropertyNames(); +} Copied: branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIWindow.java (from rev 10411, branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/UIWindow.java) =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIWindow.java (rev 0) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/model2/ui/UIWindow.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -0,0 +1,61 @@ +/****************************************************************************** + * JBoss, a division of Red Hat * + * Copyright 2006, Red Hat Middleware, LLC, and individual * + * contributors as indicated by the @authors tag. See the * + * copyright.txt in the distribution for a full listing of * + * individual contributors. * + * * + * This is free software; you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation; either version 2.1 of * + * the License, or (at your option) any later version. * + * * + * This software is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this software; if not, write to the Free * + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. * + ******************************************************************************/ +package org.jboss.portal.presentation.model2.ui; + +import org.jboss.portal.WindowState; +import org.jboss.portal.Mode; + +/** + * @author <a href="mailto:julien@jboss.org">Julien Viet</a> + * @version $Revision: 1.1 $ + */ +public interface UIWindow extends UIObject +{ + /** + * Returns the window state of the window or null if it does not exist. + * + * @return the window state + */ + WindowState getWindowState(); + + /** + * Update the window state of the window. + * + * @param windowState the new window state + */ + void setWindowState(WindowState windowState); + + /** + * Returns the mode of the window or null if it does not exist. + * + * @return the mode + */ + Mode getMode(); + + /** + * Update the mode of the window. + * + * @param mode the new mode + */ + void setMode(Mode mode); +} \ No newline at end of file Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/CustomScope.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/CustomScope.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/CustomScope.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -24,7 +24,7 @@ import org.jboss.portal.presentation.model2.ViewPortScope; import org.jboss.portal.presentation.model2.ObjectTraversalType; -import org.jboss.portal.presentation.model2.UIObject; +import org.jboss.portal.presentation.model2.ui.UIObject; import org.jboss.portal.presentation.model2.UIModel; /** Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectNode.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectNode.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectNode.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -22,7 +22,7 @@ ******************************************************************************/ package org.jboss.portal.presentation.test.model3; -import org.jboss.portal.presentation.model2.UIObject; +import org.jboss.portal.presentation.model2.ui.UIObject; import java.util.Map; import java.util.HashMap; Modified: branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectTree.java =================================================================== --- branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectTree.java 2008-03-29 01:00:35 UTC (rev 10411) +++ branches/presentation/presentation/src/main/org/jboss/portal/presentation/test/model3/UIObjectTree.java 2008-03-29 01:04:13 UTC (rev 10412) @@ -23,7 +23,7 @@ package org.jboss.portal.presentation.test.model3; import org.jboss.portal.presentation.model2.ViewPortContext; -import org.jboss.portal.presentation.model2.UIObject; +import org.jboss.portal.presentation.model2.ui.UIObject; import java.util.Map; import java.util.HashMap;